Skip to main content
POST
/
api
/
authentication
/
token
/
api-key
Authenticate with API Key
curl --request POST \
  --url https://api.telemax.com.au/api/authentication/token/api-key \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data apiKey=your_api_key_here
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 86399
}

​
Overview

Authenticates using a GUID API key stored in Telemax, or a legacy non-GUID key resolved via the configured legacy API service. Returns a JWT including API key claims (Actions, Vehicles, DateFormat, etc.) when applicable.
A V2 version of this endpoint is available: API key token. New integrations should prefer V2.

​
Endpoint

POST /api/Authentication/token/api-key

​
Authentication

Not required.

​
Request headers

HeaderRequiredDescription
Content-TypeYesapplication/x-www-form-urlencoded

​
Request body (form)

​
apiKey
string
required
API key string (GUID format or legacy format).

​
Example request body

apiKey=a3f1c2b4-5d6e-7890-abcd-ef1234567890

​
Response

200 OK — same JwtTokenResponse shape as user login.
FieldTypeDescription
access_tokenstringJWT
token_typestringbearer
expires_innumberSeconds

​
Error responses

StatusMeaning
401GUID key not found or deleted
400Legacy key could not be resolved, or no active API key row for resolved company
curl -X POST "https://api.telemax.com.au/api/Authentication/token/api-key" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "apiKey=a3f1c2b4-5d6e-7890-abcd-ef1234567890"

Authorizations

​
Authorization
string
header
required

JWT Bearer token obtained from POST /api/authentication/token/user or POST /api/authentication/token/api-key.

Lifetime: ~24 hours (86,399 seconds). Cache the token and reuse it. Re-authenticate 5 minutes before expiry.

Scoping:

  • User tokens are scoped to a single company.
  • API key tokens may restrict access to a vehicle allowlist and/or action set (see token claims).

No refresh endpoint — re-authenticate with your credentials when the token expires.

Headers

​
Content-Type
string

Standard and must keep it as it is.

Body

application/x-www-form-urlencoded
​
apiKey
string
required

API key

Example:

"your_api_key_here"

Response

Successful response

​
access_token
string

JWT access token

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

​
token_type
string
Example:

"Bearer"

​
expires_in
number<float>

Token lifetime in seconds. Default is 86399.0 (≈24 hours). Cache and reuse this token until near expiry — do not request a new token per API call.

Example:

86399