End-client: Trip search

This is an application that a company makes available to their end-clients.

The application offers the end-clients the possibility to find information about available lift for trips they are planning. The information can include aircraft details, flight times, estimated prices, etc. The end-client can then request the lift options that are of interest. This information will be available as a lead in the Avinode Marketplace. The lead will have information about the trip the end-client is planning, the options the end-client has requested, and the end-client’s contact information. The company owning the app can then access the lead directly in the Avinode Marketplace and use all the Marketplace features to find a suitable solution for the end-client.

Application parts

This application is implemented in one or more front ends, and in most cases, also includes a back end. Front ends are, in most cases, web interfaces on the company’s web site or native mobile apps. The back end can be implemented with any technology preferred by the company, for example, Java, .NET, PHP, Python, Ruby, Go, etc. Using a back end is recommended and required if the front end is a web interface. For a native mobile app it would be possible for a front end to just communicate directly with the Avinode API servers.

Searchable aircraft

The information presented to the end-client can be based on all aircraft available in the Avinode Marketplace or a subset of these. Brokers implementing this application usually base the information on all aircraft, while operators usually base the information on their own fleet.

Workflow

This diagram describes the basic workflow of the application.

587587

Find airports

The Airports API can be used to create features enabling the end-client to find airports by entering airport or city names. The Airports API also returns the airport codes that are required when calling other API operations.

The application can use a different source for airport information. However, this may increases the risk of errors if that source has some airport code information that does not match the airport code information available through the API services.

GET /airports/search

You can search airports using a text filter to match the airport code or name etc. or using Geo-location data and a max distance (radius). It is not possible to combine filter search with location search.

The results will be sorted by airport popularity based on usage data from the Avinode marketplace.

See more at GET /airports/search

🚧

Abuse

Calling the service in any repetitive or automated fashion to collect airport information is not allowed.

Find trip options

The end-client specifies trip details like airports, dates and times. The application then calls the aircraft search API service and presents the result as options to the end-client.

This page contains more information about how to implement this.

Send booking request

The end-client reviews the options, selects one or more of these, and sends a booking request.

This page contains more information about how to implement this.

Restrictions

Data displayed to the end-client

Without explicit approval from Avinode, any information that can easily identify operators may not be displayed to the end-client.

Storing data returned from the API operations

The application may only store data that is required to complete the business transaction with the end-client. So, for example, if the APIs returned information for 100 aircraft and the end-client makes a request for 2 of these, then any information about the other 98 aircraft may not be stored in the application’s back-end storage.

👍

Implementation checklist

All items on this check list must be true in order for an application of this type to be allowed to call the live Avinode Marketplace environment.

  • The application does not display any information to the end-client that easily can identify any operators.
  • The application does not store any data related to options that aren’t requested by the end-client.

What’s Next

Read more and check out the API reference for all the endpoint details:

Did this page help you?