Amadeus provides a set of APIs for the travel industry. Flights, Hotels, Locations, Trip and more.
This library requires Java version 1.8 and Kotlin version 1.3.70 minimum.
You can install the SDK via Maven or Gradle.
<dependency>
<groupId>com.amadeus</groupId>
<artifactId>amadeus-android</artifactId>
<version>0.0.5</version>
</dependency>implementation 'com.amadeus:amadeus-android:0.0.5'To send make your first API call you will need to register for an Amadeus Developer Account and set up your first application.
// Being in an Activity/Fragment/ViewModel or any file you want
val amadeus = Amadeus.Builder(context)
.setClientId("REPLACE_BY_YOUR_API_KEY")
.setClientSecret("REPLACE_BY_YOUR_API_SECRET")
.build()
// Your kotlin Coroutine scope
scope.launch {
when (val result = SampleApplication.amadeus.shopping.hotelOffers.get(
cityCode = destination,
checkInDate = checkInDate,
checkOutDate = checkOutDate
)) {
is Result.Success -> {
if (result.succeeded) {
Log.d("{$result.data}")
} else {
//call return without data
}
}
is Result.Error -> // Handle your error
}
}As you can see we don't throw Exceptions (except for some specific api cases) in the api. But we provide a Result.Error object with all the informations you need to know what happend from the backend. Coroutines and exceptions are not good friends, so with this abstraction, you can handle every use cases you want in a safe way.
The client can be initialized using dedicated builder:
val amadeus = Amadeus.Builder(context)
.setClientId("REPLACE_BY_YOUR_API_KEY")
.setClientSecret("REPLACE_BY_YOUR_API_SECRET")
.build()Alternatively it can be initialized without any parameters if the string resources R.string.amadeus_client_id and R.string.amadeus_client_secret are present.
Amadeus amadeus = Amadeus.Builder(context).build();Warning: Do not commit your credentials while using this way.
We recommend you to add your credentials by providing them through your app gradle file using one of those methods.
// Credentials from system env. variables, placed in App BuildConfig
dev {
// Your build config...
//Amadeus credentials
if (System.getenv('amadeus.api.key') != null) {
buildConfigField "String", "AMADEUS_CLIENT_ID", System.getenv('amadeus.api.key')
} else {
buildConfigField "String", "AMADEUS_CLIENT_ID", ""
}
if (System.getenv('amadeus.api.secret') != null) { // Same as above
buildConfigField "String", "AMADEUS_CLIENT_SECRET", System.getenv('amadeus.api.secret')
} else {
buildConfigField "String", "AMADEUS_CLIENT_SECRET", ""
}
}
// Credentials from user-level gradle.properties files, placed in App Strings
// /!\ This method is suitable to use Builder without credentials parameters. /!\
dev {
// Your build config...
//Amadeus credentials
if (project.hasProperty("amadeus.api.key")) {
resValue "string", "amadeus_client_id", property("amadeus.api.key")
}
if (project.hasProperty("amadeus.api.secret")) {
resValue "string", "amadeus_client_secret", property("amadeus.api.secret")
}
}Note: you can mix and match those properties, those are just examples.
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:
val amadeus = Amadeus.Builder(context)
.setHostName(Amadeus.Builder.Hosts.PRODUCTION)
.build();Amadeus has a large set of APIs, and our documentation is here to get you started today. Head over to our API documentation for in-depth information about every API.
This library conveniently maps every API path to a similar path. You have 2 ways to call the API, the first one by only passing the mandatory parameters in the right order:
For example, GET /v2/reference-data/urls/checkin-links?airlineCode=BA would be:
amadeus.referenceData.urls.checkinLinks.get("BA")The second way is to call the API by passing the name of the parameter before the value:
amadeus.referenceData.urls.checkinLinks.get(airlineCode = "LH")Similarly, to select a resource by ID, you can pass in the ID to the singular path.
For example, GET /v2/shopping/hotel-offers/XXX would be:
amadeus.shopping.hotelOffer("XXX").get()NOT IMPLEMENTED YET - DOC WILL FOLLOW
You can make any arbitrary API call as well directly with the .get, .post or .delete method.
Resource resource = amadeus.get('/v2/reference-data/urls/checkin-links',
Params.with("airlineCode", "BA"));
resource.getResult();NOT IMPLEMENTED YET
If an API endpoint supports pagination, the other pages are available under the
.next, .previous, .last and .first methods.
Location[] locations = amadeus.referenceData.locations.get(Params
.with("keyword", "LON")
.and("subType", Locations.ANY));
// Fetches the next page
Location[] locations = (Location[]) amadeus.next(locations[0]);If a page is not available, the method will return null.
To enable more verbose logging, you can set the appropriate level on your logger, though the easiest way would be to enable debugging via a parameter on initialization. You can chose between:
NONE: No logs.BASIC: Logs request and response lines.HEADERS: Logs request and response lines and their respective headers.BODY: Logs request and response lines and their respective headers and bodies (if present).
val amadeus = Amadeus.Builder(context)
.setLogLevel(Amadeus.Builder.LogLevel.BODY)
.build()// Flight Inspiration Search
val flightDestinations = amadeus.shopping.flightDestinations.get(origin = "MAD")
// Flight Cheapest Date Search
val flightDates = amadeus.shopping.flightDates.get(origin = "MAD", destination = "MUC")
// Flight Offer Search v2 GET
val flightOffersSearches = amadeus.shopping.flightOffersSearch.get(
originLocationCode = "SYD",
destinationLocationCode = "BKK",
departureDate = LocalDate.parse("2020-11-01"),
returnDate = LocalDate.parse("2020-11-08"),
adults = 2,
max = 3)
// Flight Offer Search v2 POST
// body can be a String version of your JSON or the body object
TODO
// Flight Order Management
// The flightOrderID comes from the Flight Create Orders (in test environment it's temporary)
val order = amadeus.booking.flightOrder("eJzTd9cPCzZ1CgsAAAtqAmw=").get()
// Flight Choice Prediction
// Note that the example calls 2 APIs: Flight Offers Search & Flight Choice Prediction v2
val flightOffersSearches = amadeus.shopping.flightOffersSearch.get(
originLocationCode = "SYD",
destinationLocationCode = "BKK",
departureDate = LocalDate.parse("2020-11-01"),
adults = 1,
max = 3)
// Using a JSonObject
TODO WHEN FLIGHT CHOICE PREDICTION V2 RELEASED
// Using a String
TODO WHEN FLIGHT CHOICE PREDICTION V2 RELEASED
// Flight Check-in Links
val checkinLinks = amadeus.referenceData.urls.checkinLinks.get(airlineCode = "LH")
// Airline Code LookUp
val airlines = amadeus.referenceData.airlines.get(airlineCodes = "BA")
// Airport & City Search (autocomplete)
// Find all the cities and airports starting by the keyword 'LON'
val locations = amadeus.referenceData.locations.get(
subType = listOf(Location.SubTypeEnum.AIRPORT.value, Location.SubTypeEnum.CITY.value),
keyword = "LON")
// Get a specific city or airport based on its id
val location = amadeus.referenceData.locations.pointsOfInterest("9CB40CB5D0").get()
// Airport Nearest Relevant (for London)
val locations = amadeus.referenceData.locations.airports.get(
latitude = 40.416775,
longitude = -3.703790)
// Flight Most Booked Destinations
val airTraffics = amadeus.travel.analytics.airTraffic.booked.get(
originCityCode = "MAD",
period = "2017-05")
// Flight Most Traveled Destinations
val airTraffics = amadeus.travel.analytics.airTraffic.traveled.get(
originCityCode = "MAD",
period = "2017-05")
// Flight Busiest Traveling Period
val busiestPeriods = amadeus.travel.analytics.airTraffic.busiestPeriod.get(
cityCode = "MAD",
period = "2017",
direction = "ARRIVING")
// Hotel Search API
// Get list of hotels by city code
val offers = amadeus.shopping.hotelOffers.get(cityCode = "PAR")
// Get list of offers for a specific hotel
val offers = amadeus.shopping.hotelOffersByHotel.get(hotelId = "BGLONBGB")
// Confirm the availability of a specific offer
val offer = amadeus.shopping.hotelOffer(offers.data.offers?.get(0)?.id ?: "").get()
// Hotel Ratings / Sentiments
val hotelSentiments = amadeus.ereputation.hotelSentiments.get(listOf("TELONMFS","ADNYCCTB","XXXYYY01"))
// Points of Interest
// What are the popular places in Barcelona (based a geo location and a radius)
val pointsOfInterest = amadeus.referenceData.locations.pointsOfInterest.get(
latitude = 41.397158,
longitude = 2.160873)
// What are the popular places in Barcelona? (based on a square)
val pointsOfInterest = amadeus.referenceData.locations.pointsOfInterest.bySquare.get(
north = 41.397158,
west = 2.160873,
south = 41.394582,
east = 2.177181)
// What's the likelihood flights from this airport will leave on time?
val AirportOnTime = amadeus.airport.predictions.onTime.get(
airportCode = "BOS",
date = LocalDate.parse("2020-12-01"))
// What's the likelihood of a given flight to be delayed?
TODO
val flightDelay =
// What is the the seat map of a given flight?
val seatMap = amadeus.shopping.seatMaps.get(flightOfferId = "eJzTd9f3NjIJdzUGAAp%2fAiY=")
// What is the the seat map of a given flight?
// The body can be a String version of your JSON or a Object
TODOTODO
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 StackOverflow and email.