Authentication

To generate a session token, you must provide a valid Client ID and Client Secret.

While in closed beta, you can obtain your API keys by contacting our Customer Success team.

Generate Token

Use this endpoint to generate a temporary Access Token

generate token

post

Generate token

Path parameters

regionanyRequired

gb | au

Body

application/json

clientIdstringOptional

clientSecretstringOptional

Responses

200

OK

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post

/{region}/v1/auth/token

HTTPcURLJavaScriptPython

POST /{region}/v1/auth/token HTTP/1.1
Host: app.aphex.co/
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "clientId": "text",
  "clientSecret": "text"
}

{
  "accessToken": "text",
  "expiresIn": "text",
  "tokenType": "text"
}

Revoke Token

Use this endpoint to revoke a previously generated Access token

revoke token

post

Revoke token

Path parameters

regionanyRequired

gb | au

Body

application/json

clientIdstringOptional

clientSecretstringOptional

tokenstringOptional

Responses

200

OK

application/json

Responsestring

404

Not Found

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post

/{region}/v1/auth/token/revoke

HTTPcURLJavaScriptPython

POST /{region}/v1/auth/token/revoke HTTP/1.1
Host: app.aphex.co/
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "clientId": "text",
  "clientSecret": "text",
  "token": "text"
}

text