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

Generate token

POSThttps://app.aphex.co/{region}/v1/auth/token

Path parameters

region*enum

gb | au

gbau

Body

application/json

generator token payload

clientIdstring

clientSecretstring

Response

200404422500

OK

Body

application/json

accessTokenstring

expiresInstring

tokenTypestring

Request

JavaScriptCurlPython

const response = await fetch('https://app.aphex.co/{region}/v1/auth/token', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404422500

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

Revoke Token

Use this endpoint to revoke a previously generated Access token

revoke token

Revoke token

POSThttps://app.aphex.co/{region}/v1/auth/token/revoke

Path parameters

region*enum

gb | au

gbau

Body

application/json

revoke token payload

clientIdstring

clientSecretstring

tokenstring

Response

200404422500

OK

Body

application/json

string

Request

JavaScriptCurlPython

const response = await fetch('https://app.aphex.co/{region}/v1/auth/token/revoke', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404422500

text