Getting Started Guide
This guide collects the resources you need to get started using the JSON Hotel APIs.
In this guide:
- Provisioning
- Developer Toolkits
- Authorization
- Concepts and Terms
- Endpoints and API References
- Headers, Errors, Troubleshooting, and Support
Provisioning
Travelport provides the credentials required for the JSON APIs when you sign up with Travelport and are provisioned with specific APIs. If you aren't a current Travelport customer, send a Sales Inquiry form to learn more about our products.
Developer Toolkits
You can find OAS (Swagger) files and a Postman collection in the Hotel Developer Toolkits.
Authorization
The JSON APIs use OAuth 2.0 for authentication. You must send the credentials provided at provisioning to generate an authorization token to send in all subsequent API requests. A new auth token is required every 24 hours. See Authentication.
Concepts and Terms
The JSON Hotel APIs support light and responsive payloads by using a workflow of linked API calls to move through the required steps to search, confirm availability, and book hotel rooms.
The JSON Hotel APIs Guide is the best starting point to learn about how the JSON APIs work and the terminology used in the travel industry.
Be sure to read the Hotel Search Guide. All linked JSON API workflows start with the search APIs, so you'll see the search concepts and example code patterns in this guide through all the JSON APIs.
See the list of Hotel Guides for usage for each area of hotel travel development. Each guide covers basic concepts, supported functionality, workflows, and other information for that area.
For a list of both travel terminology and terms specific to JSON API concepts, see the Hotel Glossary.
Endpoints and API References
While the Guides provide general usage information, every JSON Hotel API has a complete API reference that provides all of the following in the same standard format:
-
Reference tables detailing every object in the request and response
-
Example request
-
Example response
See the API Reference List for all API references grouped by resource.
For a consolidated list of all endpoints and supported methods for each, see the Endpoints List.
Headers, Troubleshooting, and Support
Most other resources you need are on the General menu at the top of every page in this help, including:
-
Common Hotel Headers: The values every API request must pass in its header.
-
Transaction and Trace IDs: System-generated and custom values for tracking transactions in case you need to contact support.