Session Authenticator

This authentication scheme is used when website sessions wish to use the API.

Authentication Headers

The following headers are used to identify yourself to the API client. These should be sent as standard HTTP headers with any API request.

Header Example


The session ID you wish to authenticate with.



The errors listed below may be raised if any issues occur when verifying your identity with the API.

Error Attributes


The session ID provided in X-Session-ID was not valid.