Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hopper Sessions API

Hopper uses a unique ID to correlate API calls and events produced by a user's interaction with an airline application.The duration of the user's interactions is called a "session", and the correlation ID is called a `session_id`.A session begins immediately before the airline’s first API call to Hopper, and the airline must call the Create a Session endpoint at this time. A `session_id` is returned from this call; it must be included with each subsequent API call via the `HC-Session-ID` header. No airline action is required to end the session.

Hopper Sessions API is one of 5 APIs that Hopper publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sessions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 31 schemas. It is described by OpenAPI 3.0.3, at version v1.1.

Requests are made against a single base URL, https://airlines-api.hopper.com/airline/v1.1.

1 operations 1 paths 31 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1.1
Base URL
https://airlines-api.hopper.com/airline/v1.1
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Hopper Sessions API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (PartnerAuth). An API key is passed in the header as HC-Session-ID (SessionAuth).

  • PartnerAuth — This API is authenticated with OAuth 2, Client Credentials grant.\ Clients should use their clientid and clientsecret to obtain an accesstoken.\ The accesstoke…
  • SessionAuth — Header Parameters | headerName | description | |-----------------|---------------------------------------------------------------------------------------------…

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Sessions 1

Hopper uses a unique ID to correlate API calls and events produced by a user's interaction with an airline application. The duration of the user's interactions is called a "sessio…

POST
/sessions
Create a Session
postSessions body → 201204400401403404422500

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are create_airline_session_request (7 properties), mobile (5 properties), tablet (5 properties), desktop (5 properties). Each schema is shown below with its type and property counts.

opera
object
2 properties 1 required
other_os
object
3 properties 2 required
operating_system
browser
other_browser
object
3 properties 2 required
platform
desktop
object
5 properties 2 required
airline_session
object
A airline session resource
1 property 1 required
windows
object
2 properties 1 required
app
object
2 properties 1 required
edge
object
2 properties 1 required
mac_os
object
2 properties 1 required
web
object
3 properties 1 required
tablet
object
5 properties 2 required
internet_explorer
object
2 properties 1 required
device
The end-user's device
bad_request
object
1 property 1 required
android
object
2 properties 1 required
unprocessable_entity
object
1 property 1 required
error
object
3 properties 1 required
mobile
object
5 properties 2 required
linux
object
2 properties 1 required
chrome_os
object
2 properties 1 required
product
string
The product for which the session is opened. Required for sessions having flowtype "exercise".
user_info
object
An object containing information related to the airline's user. Should be included if known, but not if the user is anonymous.
3 properties 1 required
safari
object
2 properties 1 required
create_airline_session_request
object
7 properties 3 required
i_os
object
2 properties 1 required
firefox
object
2 properties 1 required
flow_type
string
The flow type for which the session is opened.
chrome
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hopper-com-sessions-api-openapi.yml Raw ↑

Other APIs Hopper publishes across the network.

Hopper Analytics API
Hopper Authentication API
Hopper Cancel For Any Reason (CFAR) API
Hopper Disruption Guarantee (DG) API