Last updated 4 minutes ago

New Routehappy API

The new Routehappy API provides access to all Routehappy Content types: Amenities, Universal Product Attributes (UPAs), and Universal Ticket Attributes (UTAs). This API provides two different, but equally effective, types of endpoints that provide access to Routehappy Content.

Endpoints

  • Consolidated Routehappy endpoint: a single endpoint that provides access to all Routehappy Content types - Amenities, UPAs, and UTAs - from a single request, with a new schema and new functionality compared with the previous Routehappy Rich Content APIs

  • Backwards Compatible endpoints: Backwards-compatible Amenities and Hub endpoints for users of the previous Routehappy Rich Content APIs. With a few minor updates to their code (i.e., changes to the authorization headers and the endpoint URL), users of the previous APIs can use the same request/response structures with the new API. These backwards-compatible endpoints are intended for users of the previous Routehappy Rich Content APIs who are not ready to migrate to the Consolidated endpoint yet.

Enhancements and Improvements

In addition to providing two ways to access Routehappy Content, we have made significant improvements in the new Routehappy API.

  • Updated Technology & Architecture - We have a completely new tech stack utilizing Rust and Go that guarantees robust performance, more stable operation, faster processing speed and better resource utilization. We’re also using a new microservice architecture for distributed cloud deployment with sophisticated scalability capabilities.
  • Improved Response Times - The speed at which data is sent and received will be dramatically improved, handling higher volumes of data faster. We will also be able to support more legs/segments per request with more concurrent transactions overall.
  • More Accurate Processing - With so many fares in the market and so many different ways to construct fares, we are building key fare identification services to maximize processing accuracy as much as possible. Requests to the new Consolidated endpoint will be based on the full itinerary, and requests will be able to include other key pieces of information like RBD, passenger type, and even ticket designators for processing of corporate fares.
  • Consolidated Access - All Routehappy Content will be available from one endpoint. So, in one API call, you can request Amenities, UPAs, and UTAs returned. (Applies to the Consolidated endpoint only.)

Which Endpoint Should I Use?

Consolidated Endpoint

This option provides single-endpoint access to Amenities, UPAs, and UTAs with additional features and flexibility. This option includes a number of enhancements and improvements.

Backwards Compatible Endpoints

This option allows you to continue to use the same requests and response processing you used with the legacy Routehappy Rich Content APIs, with the performance benefits of the new Routehappy API. This option is recommended only for those users of the legacy APIs who are not yet ready to migrate to the Consolidated Endpoint. There are, however, some differences between the Backwards Compatible endpoint and the legacy APIs.

  • New authorization method: for increased security and request tracking, the new Routehappy API requires calls to include both an API key and an OAuth Bearer Token in the request header. API keys should be specified in a x-api-key parameter and the Bearer Token should be specified in an Authorization parameter. Bearer Tokens are valid for one (1) hour before you’ll need to obtain a fresh one.
  • New host and endpoint URL
  • The existing Scores product, available from the legacy Scores & Amenities (S&A) API, will be decommissioned with the launch of the new Routehappy API. Neither the new Amenities Backwards Compatible endpoint nor the Consolidated Routehappy endpoint will include scores data.
  • Other than Scores (as mentioned in bullet above), the data returned in the response from the new Amenities Backwards Compatible endpoint will match the legacy S&A API; however, the order of parameters in the response may be different.
  • Responses to the Hub Backwards Compatible endpoint will contain the same parameters as those received from the legacy Hub API, but the order of parameters in the response may be different.

How Do I Make the Change?

This portal includes a Migration Guide for those coming from the legacy Routehappy APIs, as well as instructions on how to authorize your calls to the new Routehappy API, documentation for the API, and the ability to quickly run test calls. If you're migrating from the legacy APIs, we recommend starting with the Migration guide and using the other resources as necessary. If you have any suggestions for improvements, please let us know, so that we can grow this portal into a self-service one-stop resource for ATPCO API users.