https://github.com/afonsoft/afonsoft.amadeus
C# library for the Amadeus Self-Service travel APIs
https://github.com/afonsoft/afonsoft.amadeus
ai amadeus api csharp-library flights hotels library sdk self-service travel travel-content travel-insight
Last synced: 5 months ago
JSON representation
C# library for the Amadeus Self-Service travel APIs
- Host: GitHub
- URL: https://github.com/afonsoft/afonsoft.amadeus
- Owner: afonsoft
- License: mit
- Created: 2019-07-02T16:51:04.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T05:46:30.000Z (almost 3 years ago)
- Last Synced: 2025-04-28T10:55:16.494Z (6 months ago)
- Topics: ai, amadeus, api, csharp-library, flights, hotels, library, sdk, self-service, travel, travel-content, travel-insight
- Language: C#
- Homepage: https://developers.amadeus.com/
- Size: 51.8 KB
- Stars: 4
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Amadeus CSharp SDK
Amadeus provides a set of APIs for the travel industry. Flights, Hotels, Locations and more.
For more details see the on
[Amadeus.com](https://developers.amadeus.com).
## Getting Started
To send make your first API call you will need to [register for an Amadeus
Developer Account](https://developers.amadeus.com/create-account) and set up
your first application.
```c#
using Afonsoft.Amadeus.Amadeus;
using Afonsoft.Amadeus.Params;
using Afonsoft.Amadeus.exceptions.ResponseException;
using Afonsoft.Amadeus.referenceData.Locations;
using Afonsoft.Amadeus.resources.Location;
public class AmadeusExample {
public static void main(String[] args) {
Amadeus amadeus = Amadeus
.builder("REPLACE_BY_YOUR_API_KEY", "REPLACE_BY_YOUR_API_SECRET")
.build();
Location[] locations = amadeus.referenceData.locations.get(Params
.with("keyword", "LON")
.and("subType", Locations.ANY));
}
}
```
## Initialization
The client can be initialized directly.
```c#
//Initialize using parameters
Amadeus amadeus = Amadeus
.builder("REPLACE_BY_YOUR_API_KEY", "REPLACE_BY_YOUR_API_SECRET")
.build();
```
Alternatively it can be initialized without any parameters if the environment
variables `AMADEUS_CLIENT_ID` and `AMADEUS_CLIENT_SECRET` are present.
Your credentials can be found on the [Amadeus
dashboard](https://developers.amadeus.com/my-apps). [Sign
up](https://developers.amadeus.com/create-account) 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
## Documentation
Amadeus has a large set of APIs, and our documentation is here to get you
started today. Head over to our
[Reference](https://amadeus4dev.github.io/amadeus-java/) documentation for
in-depth information about every SDK method, its arguments and return types.
* [Get Started](https://amadeus4dev.github.io/amadeus-java/) documentation
* [Initialize the SDK](https://amadeus4dev.github.io/amadeus-java/)
* [Find an Airport](https://amadeus4dev.github.io/amadeus-java/)
* [Find a Flight](https://amadeus4dev.github.io/amadeus-ruby/)
* [Get Flight Inspiration](https://amadeus4dev.github.io/amadeus-ruby/)
## Making API calls
This library conveniently maps every API path to a similar path.
For example, `GET /v2/reference-data/urls/checkin-links?airlineCode=BA` would be:
```c#
amadeus.referenceData.urls.checkinLinks.get(Params.with("airlineCode", "BA"));
```
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:
```c#
amadeus.hotelOffer("XXX").get(...);
```
You can make any arbitrary API call as well directly with the `.get` method.
Keep in mind, this returns a raw `Resource`
```c#
Resource resource = amadeus.get('/v2/reference-data/urls/checkin-links',
Params.with("airlineCode", "BA"));
resource.getResult();
```
## Response
Every successful API call returns a `Resource` object. The underlying
`Resource` with the raw available.
```c#
Location[] locations = amadeus.referenceData.locations.get(Params
.with("keyword", "LON")
.and("subType", Locations.ANY));
// The raw response, as a string
locations[0].getResponse().getBody();
```
## Pagination
If an API endpoint supports pagination, the other pages are available under the
`.next`, `.previous`, `.last` and `.first` methods.
```c#
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`.
## Logging & Debugging
The SDK makes it easy to add your own logger.
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.
## List of supported endpoints
```c#
// Flight Inspiration Search
FlightDestination[] flightDestinations = amadeus.shopping.flightDestinations.get(Params
.with("origin", "MAD"));
// Flight Cheapest Date Search
FlightDate[] flightDates = amadeus.shopping.flightDates.get(Params
.with("origin", "MAD")
.and("destination", "MUC"));
// Flight Low-fare Search
FlightOffer[] flightOffers = amadeus.shopping.flightOffers.get(Params
.with("origin", "NYC")
.and("destination", "MAD")
.and("departureDate", "2019-08-01"));
// Flight Check-in Links
CheckinLink[] checkinLinks = amadeus.referenceData.urls.checkinLinks.get(Params
.with("airlineCode", "G3"));
// Airline Code LookUp
Airline[] airlines = amadeus.referenceData.airlines.get(Params
.with("airlineCodes", "G3"));
// Airport & City Search (autocomplete)
// Find all the cities and airports starting by the keyword 'LON'
Location[] locations = amadeus.referenceData.locations.get(Params
.with("keyword", "LON")
.and("subType", Locations.ANY));
// Get a specific city or airport based on its id
Location location = amadeus.referenceData
.location("ALHR").get();
// Airport Nearest Relevant (for London)
Location[] locations = amadeus.referenceData.locations.airports.get(Params
.with("latitude", 0.1278)
.and("longitude", 51.5074));
// Flight Most Searched Destinations
// Which were the most searched flight destinations from Madrid in August 2017?
SearchedDestination searchedDestination = amadeus.travel.analytics.airTraffic.searchedByDestination.get(Params
.with("originCityCode", "MAD")
.and("destinationCityCode", "NYC")
.and("searchPeriod", "2017-08")
.and("marketCountryCode", "ES"));
// How many people in Spain searched for a trip from Madrid to New-York in September 2017?
Search[] search = amadeus.travel.analytics.airTraffic.searched.get(Params
.with("originCityCode", "MAD")
.and("searchPeriod", "2017-08")
.and("marketCountryCode", "ES"));
// Flight Most Booked Destinations
AirTraffic[] airTraffics = amadeus.travel.analytics.airTraffic.booked.get(Params
.with("originCityCode", "MAD")
.and("period", "2017-08"));
// Flight Most Traveled Destinations
AirTraffic[] airTraffics = amadeus.travel.analytics.airTraffic.traveled.get(Params
.with("originCityCode", "MAD")
.and("period", "2017-01"));
// Flight Busiest Traveling Period
Period[] busiestPeriods = amadeus.travel.analytics.airTraffic.busiestPeriod.get(Params
.with("cityCode", "MAD")
.and("period", "2017")
.and("direction", BusiestPeriod.ARRIVING));
// Hotel Search API
// Get list of hotels by city code
HotelOffer[] offers = amadeus.shopping.hotelOffers.get(Params
.with("cityCode", "MAD"));
// Get list of offers for a specific hotel
HotelOffer hotelOffer = amadeus.shopping.hotelOffersByHotel.get(Params.with("hotelId", "BGLONBGB"));
// Confirm the availability of a specific offer
HotelOffer offer = amadeus.shopping.hotelOffer("4BA070CE929E135B3268A9F2D0C51E9D4A6CF318BA10485322FA2C7E78C7852E").get();
// Points of Interest
// What are the popular places in Barcelona (based a geo location and a radius)
PointOfInterest[] pointsOfInterest = amadeus.referenceData.locations.pointsOfInterest.get(Params
.with("latitude", "41.39715")
.and("longitude", "2.160873"));
// What are the popular places in Barcelona? (based on a square)
PointOfInterest[] pointsOfInterest = amadeus.referenceData.locations.pointsOfInterest.bySquare.get(Params
.with("north", "41.397158")
.and("west", "2.160873")
.and("south", "41.394582")
.and("east", "2.177181"));
```
## License
This library is released under the [MIT License](LICENSE).
## Help
Our [developer support team](https://developers.amadeus.com/support) is here
to help you. You can find us on
[StackOverflow](https://stackoverflow.com/questions/tagged/amadeus) and
[email](mailto:developers@amadeus.com).