Get Started
Welcome to the Horizon Blue Developer Portal. Find out what our APIs do, how they work, and how you can innovate with them. Here you have the opportunity to shape the future of travel. Across this Developer Portal, you'll find a wealth of information, along with a strong developer community, and resources for support.
On this page, you'll find a short guide on how to get you started with our APIs and allow you to begin integrating our services into your applications.
This guide will cover these main areas:
- Registration: Information on setting up an account to get you up and running.
- Getting an API Key: How to get an API Key.
- Authentication: Method and steps for Authentication.
- Consuming an API: How to consume an API of your choice.
- Error Handling: An overview of the error-handling model.
- Support: Where to go for questions, queries, answers - were here to help.
Getting an API Key
First, create a new App for production. By doing so, you will get a different API-Key which you can use for your production environment.
To get production access, it is important that both your account and App details are registered correctly.
Subscribe to the API products you want to use in the production environment.
Submit your request and contact us to request production access. Depending on the API, our API Services team might contact you to discuss the details of your request.
Once approved, you are ready to use our API in a live environment.
Authentication
The authentication for this API is done on the basis of access token. To obtain an access token, you need to call our OAuth API. The authentication mechanism can vary per API depending on the required level of authentication.
Environments
These are the URLs for the endpoints to get the tokens.
Sandbox: https://auth sandbox.connect.example.com
Production: https://auth.connect.example.com
OAuth Flows
Our APIs are secured using OAuth 2.0. This means you will need to pass an access token when making your request to the APIs. This page will explain how to obtain an access token. We use the following three flows for getting an access token: Client credentials, Authorization code flow and Refresh token.
If you want to go more in depth on some of the OAuth protocol, have a look at the OAuth RFC.
Consuming An API
When you have reached the stage of actually consuming one of our APIs, you will follow the below steps.
- Find an API from our documentation section
- Include your token/API key in your request as an Authentication header
- Include your token as a "Bearer" token in the "Authorization" header.
Ex:Authorization: Bearer 0b79bab50daca910b000d4f1a2b675d604257e42
Error Handling
Error Format
During the course of any API consumption, and in the event of receiving an error, all APIs throw errors are returned in the following JSON format:
"errors": [
{
"code": "ERROR_UNIQUE_CODE",
"message": "ERROR_MESSAGE",
"category" : "SHORT_DESCRIPTION/ERROR_CATEGORY",
"reference" : "API_DOCUMENTATION_LINK",
"status" : "HTTP_STATUS_CODE",
"traceId" : "UUID"
}
]
Support
Questions or problems? We are happy to help.
Can't find the answer you need? Please contact us and we will get back to you as soon as possible.