API Auth
OPTIONS /apiAuth
Purpose
Provides CORS support information for the endpoint.
Responses
Always 200 OK with CORS response headers.
POST /apiAuth
Purpose
Exchange an API key for a token to be used in further API queries.
Add the token to GraphQL queries using the HTTP headers:
Authorization: Bearer $tokenAuth-Provider: apiKeyAuth
Payload
Type
JSON in body.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
key | Yes | String | API key associated with an API user. |
Responses
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 405 Method Not Allowed
JSON body with a single property:
token: Token value to used for further API requests.
Indicates missing required payload parameters.
Indicates the key is invalid or disabled.
Indicates an invalid Origin header was passed in a CORS request.
Returned for any unsupported HTTP method.