Amadeus provides a set of APIs for the travel industry. Flights, Hotels, Locations and more.
For more details see the Ruby documentation on Amadeus.com.
This gem requires Ruby 2.2+. You can install install it directly or via bundler.
gem 'amadeus'
Next: Get Started with the Ruby SDK.
To send make your first API call you will need to register for an Amadeus Developer Account and set up your first application.
require 'amadeus'
amadeus = Amadeus::Client.new({
client_id: '[YOUR_CLIENT_ID]',
client_secret: '[YOUR_CLIENT_SECRET]'
})
begin
puts amadeus.reference_data.urls.checkin_links.get({ airline: '1X' })
# => {"meta"=>{"count"=>2, "links"=>{"self"=>"https://test.api.amadeus.com...
rescue Amadeus::ResponseError => error
puts error
end
Next: Learn more about checkin links with our Ruby SDK.
The client can be initialized directly.
# Initialize using parameters
amadeus = Amadeus::Client.new(client_id: '...', client_secret: '...')
Alternatively it can be initialized without any paramters if the environment variables AMADEUS_CLIENT_ID and AMADEUS_CLIENT_SECRET are present.
amadeus = Amadeus::Client.new
Your credentials can be found on the Amadeus dashboard. Sign up for an account today.
By default the environment for the SDK is the :test environment. To switch to a production (paid-for) environment please switch the hostname as follows:
amadeus = Amadeus::Client.new(hostname: :production)
Next: Learn more about our initializing the Ruby SDK in our documentation.
Amadeus has a large set of APIs, and our documentation is here to get you started today.
Alternatively, head over to our Reference documentation for in-depth information about every SDK method, it's arguments and return types.
Additionally, this SDK has extensive documentation of itself available on RubyDoc.info.
This library conveniently maps every API path to a similar path.
For example, GET /v2/reference-data/urls/checkin-links?airline=1X would be:
amadeus.reference_data.urls.checkin_links.get(airline: '1X')
Similarly, to select a resource by ID, you can pass in the ID to the path.
For example, GET /v1/shopping/hotel/123/hotel-offers would be:
amadeus.hotels(123).hotel_offers.get(...)
You can make any arbitrary API call as well directly with the .get method:
amadeus.get('/v2/reference-data/urls/checkin-links', airline: '1X')
Every API call returns a Amadeus::Response object. If the API call contained
a JSON response it will parse the JSON into the .result attribute. If this data
also contains a data key, it will make that available as the .data
attribute. The raw body of the response is always avaulable as the .body attribute.
response = amadeus.reference_data.locations.get(
keyword: 'LON',
subType: Amadeus::Location::ANY
)
p reponse.body #=> The raw response, as a string
p reponse.result #=> The body parsed as JSON, if the result was parsable
p response.data #=> The list of locations, extracted from the JSON
If an API endpoint supports pagination, the other pages are available under the
.next, .previous, .last and .first methods.
response = amadeus.reference_data.locations.get(
keyword: 'LON',
subType: Amadeus::Location::ANY
)
amadeus.next(response) #=> returns a new response for the next page
If a page is not available, the method will return nil.
The SDK makes it easy to add your own logger.
require 'logger'
amadeus = Amadeus::Client.new(
client_id: '...',
client_secret: '...',
logger: Logger.new(STDOUT)
)
Additionally, to enable more verbose logging, you can set the appropriate level on your own logger, though the easiest way would be to enable debugging via a parameter on initialization, or using the AMADEUS_LOG_LEVEL environment variable.
require 'logger'
amadeus = Amadeus::Client.new(
client_id: '...',
client_secret: '...',
log_level: 'debug'
)
Want to contribute? Read our Contributors Guide for guidance on installing and running this code in a development environment.
This library is released under the MIT License.
Our developer support team is here to help you. You can find us on Twitter, StackOverflow, and email.