Authentication
IP allowlisting
Any IPs accessing our NDC gateway must be explicitly allowlisted. Please provide a list of IPs you will use to access our gateway, and specify whether these IPs will access our sandbox or production environments. Requests to allow additional IPs are typically fulfilled within one week.
Gateway authorization
All requests to the Breeze NDC gateway must provide an Ocp-Apim-Subscription-Key
header.
This secret is unique to each partner and each environment.
Session authorization
Authentication requests create a unique, stateful session in Breeze's reservation system for shopping and order management. A unique authentication token must be used for each shopping session starting from OfferPrice.
Credential exchange
Breeze sends credentials to a named contact with our partners using a secure BitWarden link from https://send.bitwarden.com
. This link has a limited number of uses and expires.
- Request
- Response
- Errors
Authorization header: Basic {Credential}
{
"grant_type":"client_credentials"
}
Authentication requests are twice as fast when the optional role parameter is declared. When role codes are undefined, our NDC gateway must make an additional network request to the reservation system.
{
"grant_type":"client_credentials"
}
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuc2stc2lnbmF0dXJlIjoiYjV1ZllVT1JTK0k9fElLZVRJR0ZFeTllV25FS3czZlMweDYyM0ZVY1o0K09BUURTUnJ1YmJQYk1ENVdaQ2FrZGFjeW0vUm8zNUl4YndVQWpsc0xyZFVwMWdWM3dPRktvekNZdW16dFMweTBwa2p2c0RyMjhtd0Iwd1dUdUxpUkxjMkFLMThtSGpreE81allUVVhSS01TMjA9IiwidXNlcm5hbWUiOiJXVzJcXEV4cGVkaWFOREMiLCJyb2xlY29kZSI6Ik5EQ08iLCJhdWQiOlsic2hvcHBpbmciLCJzZWxsaW5nIiwic2VydmljaW5nIiwib3JkZXJjaGFuZ2Vub3RpZmljYXRpb24iXSwiZXhwIjoxNzQxNzE0Njg4LCJpc3MiOiJuZGNnYXRld2F5Lm5hdml0YWlyZS5jb20ifQ.P3UbH1Yll1tfhdrNP_VZdocLTSt1zEJdcgaC5WL92Lk",
"token_type": "Bearer",
"expires_in": "00:30:00"
}
Symptoms
- Response header
WWW-Authenticate: AzureApiManagementKey
Remedy
- Provide a valid Azure API gateway key using an
Ocp-Apim-Subscription-Key
header
Symptoms
- Response header
Error-Code-0: CF4000
- Response header
Error-Msg-0: Unable to find best role for agent…
Cause
- The role code defined in the URL does not match the key provided in the Authorization token
Remedy
- Correct the
role
parameter value OR - remove the parameter from the authentication request
Symptoms
- Response header
Error-Code-0: CF4000
- Response header
Error-Msg-0: Unable to decode credentials. Please ensure correct format.
Causes
- No authorization header provided OR
- Invalid key provided
- Invalid key provided
Remedy
- Provide valid credentials
Symptoms
- Response header
Error-Code-0: CF4000
- Response header
Error-Msg-0: The agent [*agent name*] is locked.
Causes
- Multiple invalid login credential attempts OR
- Breeze initiated an agent lock
Remedy
- Contact Breeze to request agent unlock