Get started with Trips and Waivers

Our Trips and Waivers products let you build rich, full-featured applications that leverage our expertise and industry-leading knowledge.

To use the services, you first need to contact Cirium to get access to the APIs. This also involves an onboarding process where the trip services are configured for your need.

Our services are centered on customer trips that you provide the platform. One option is to use the Trip Import API to load your trips onto the platform. Alternatively, we can load trips from GDS or back-office systems. Setup for integration with GDS or back-office implementations is part of the onboarding process.

Once trips are loaded into the system, they can be retrieved using the Trip Status API that returns the trip along with the current flight status. Alternatively, the services can be configured to make callbacks to your system or send notifications via email or short SMS messages.

A variety of triggers are available, depending on your configuration. Alerts can be sent to travelers or to your employees.

See Traveler Trip Alerts and Agent Alerts for details about the types of alerts sent.

Your account can also be configured to send alerts about waivers. See Waiver Alerts for information about the types of alerts.

Steps

  1. Contact us to get an account
  2. Cirium representatives will work with you to properly configure services during an onboarding process
  3. Load trips
  4. Setup callbacks to your system or retrieve trips using the Trip Status API

Request structure

Here's the request structure for Trips and Waivers.

Supported protocols

Trips and Waivers are a combination of REST APIS returning JSON and PUSH services that either send emails directly or make callbacks to your defined endpoints.

Authenticating

Each service invocation is authenticated using your application ID (appId) and application key (appKey).

To acquire an application ID and key:

  1. login to developer.flightstats.com
  2. Click the Create a new application button
  3. Provide a name and description and click the Create Application button. This provides you with an application ID and Key
  4. Pass the App ID and Key as part of the request.
  5. We'll contact you so that you can use the Trips and Waivers APIs

For the REST APIs, the credentials are query parameters:

https://trips-api.flightstats.com/alerts?appId=12345678&appKey=abcdefghijklmnopqrstukwxyz123456

REST URI structure

All URIs follow a common pattern:

  1. Base URI: https://trips-api.flightstats.com
  2. API name: For example, /alerts
  3. Parameters, if desired: ?maxAlerts=1

Response structure and options

API responses always include the following elements:

  • Response-specific data such as alerts elements
  • error is for failed requests and information about the error. It's present but empty for successful requests