Traveler API

Architecture of the Guestlogix RESTful API

Documentation

The Traveler REST API utilizes Swagger to autogenerate the specification. It can be found here. The conventions around naming, data types etc. can be found in the API Convention page.

Device Information

Any request made to the Traveler API must include device specific information. This required headers are outlined below.

Header

Type

Example Value

Purpose

x-device-id

String

50565c00-6bba-4b7f-bfc2-593c50520e21

A value representing a unique installation of the application on a user's device.

x-os-version

String

iOS12.1

The version of the operating system of the device making the request.

x-language

String

en

The ISO 639-1 two letter language code of the user's device.

x-locale

String

en-US

The Locale as defined by Apple guidelines.

x-region

String

CA

The ISO-3166 two character country code from which the requesting device is from.

x-application-id

String

com.guestlogix.traveler

The Unique identifier of the application that is using the SDK or API.

x-timezone

String

UTC

The timezone abbreviation that the device is displaying time in.