Postman collections#
To facilitate API discovery and streamline your development process, we provide two comprehensive Postman collections:
These collections include ready-to-use calls and typical error cases, allowing users to explore and interact with the API using their credentials.
How to use Amadeus Discover Postman collections?#
Step 1: Set up targeted environment#
To begin using our Postman collections, first, download the targeted environment file from the provided links. Import this environment file into your Postman application to set up the working environment.
This setup is crucial for ensuring that your API calls are correctly configured and aligned with the sandbox-consumer or production environment you are targeting.
Environment |
Postman environment JSON file |
---|---|
Sandbox-Consumer |
|
UAT |
|
Production |
Step 2: Tune to your credentials#
Next, configure the environment with your credentials.
Depending on your authentication method, you will need to set either Client Credentials Grant (for client credentials) or Password Grant (for user credentials) in the environment variables.
For Client Credentials Grant (Machine-to-Machine Authentication)
Set the following environment variables:
client_id → your API client ID
client_secret → your API client secret
For Password Grant (User Authentication) → Legacy
Set the following environment variables:
csm_api_username → your API username
csm_api_password → your API password
Properly tuning these settings ensures that all API calls you make are authenticated and authorized, allowing you to interact securely with the API.
Step 3: Import and run collection#
Finally, import the targeted Postman collection file into your application.
In order to perform the first calls, set Postman to the imported environment in the upper right part of the Postman interface, then run the Token authentication query that correspond to your grant method in the collection.
If your credentials are valid in the targeted environment you should receive a success with a token. From that point, you will be able to perform any query in the collection.
Please note that
You need to run the token authentication before sending any query (else server will respond error 401 Unauthorized)
Token lifespan is 300 seconds. In case the token expires, this authentication process will need to be re-initiated to get access to the API.
Postman collection – Book products#
The Book products collection focuses on the booking flow, guiding users through the entire process from checking live availability for an activity to completing a booking.
Postman collection JSON: Book products Postman collection
.