IEndpoints

Endpoints used to retrieve data from the services.

NOTE: You should not need to alter any of these settings under normal circumstances. Please refer to the integration guide before making changes.

Signature:

export interface IEndpoints

Properties

Property	Type	Description
crop	string	The endpoint used for getting image boundaries for the cropping functionality.
getCapturingMedia	string	The endpoint used for getting capturing media
getJourney	string	The endpoint used for retrieving information about past journeys
getVersion	string	The endpoint used for getting the current API version from the services as well as getting the configuration parameters for the input provider to use.
journeyDefinitions	string	The endpoint used for requesting the available journey definitions
login	string	The endpoint used for authenticating with the services and obtaining an API token providing a username and password combination.
logout	string	The endpoint used for terminating a session given the specified token.
postToken	string	The endpoint used for posting token information to the services
socket	string	The endpoint used for negotiating a socket connection with the services
upload	string	The endpoint used for uploading images to when using the more traditional providers.

IEndpoints.crop property

The endpoint used for getting image boundaries for the cropping functionality.

Signature:

readonly crop: string;

IEndpoints.getCapturingMedia property

The endpoint used for getting capturing media

Signature:

readonly getCapturingMedia: string;

IEndpoints.getJourney property

The endpoint used for retrieving information about past journeys

Signature:

readonly getJourney: string;

IEndpoints.getVersion property

The endpoint used for getting the current API version from the services as well as getting the configuration parameters for the input provider to use.

Signature:

readonly getVersion: string;

IEndpoints.journeyDefinitions property

The endpoint used for requesting the available journey definitions

Signature:

readonly journeyDefinitions: string;

IEndpoints.login property

The endpoint used for authenticating with the services and obtaining an API token providing a username and password combination.

Signature:

readonly login: string;

IEndpoints.logout property

The endpoint used for terminating a session given the specified token.

Signature:

readonly logout: string;

IEndpoints.postToken property

The endpoint used for posting token information to the services

Signature:

readonly postToken: string;

IEndpoints.socket property

The endpoint used for negotiating a socket connection with the services

Signature:

readonly socket: string;

IEndpoints.upload property

The endpoint used for uploading images to when using the more traditional providers.

Signature:

readonly upload: string;