Skip to main content

Prerequisites — Create an API Key

Before making any API calls, you’ll need an API key. Head to the Telemax Webhooks and API Key section in the Telemax dashboard to create your own key.
Navigate to Telemax Dashboard → Webhooks and API Key to generate a new API key. Copy the key and keep it secure — you’ll use it in the step below.

Step 1 — Get an access token

Interactive reference: API key token · Dashboard user token.
curl -s -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"
200 OK response shape:
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer",
  "expires_in": 86399.0
}

Step 2 — Call an authenticated endpoint

Almost all routes use POST with parameters in the query string (not JSON body) — see the architecture note for details. The only GET endpoints are GetDeviceId and devices/{deviceId}/dtc-codes. Example: GetLastPositionData for legacy vehicle 88421:
curl -s -X POST "https://api.telemax.com.au/api/GetLastPositionData?id=88421" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
200 OK returns a PositionDto JSON object (see Request & response) with fields such as Lat, Lng, UtcTime, DeviceId (legacy id), IMEI, etc.

Common first errors

SymptomCauseFix
401 with no bodyMissing or invalid Authorization headerObtain a fresh token; prefix with Bearer
401 from token endpointWrong password or unknown API keyVerify credentials; GUID keys must exist in ApiKeys non-deleted
400 from token endpointAPI key invalid for legacy pathLegacy keys must resolve via the configured legacy API service
404 on data routeVehicle legacy id unknownConfirm vehicle exists; use GetDeviceId if you only have IMEI
Empty access_tokenParsing errorEnsure Content-Type is form-urlencoded, not JSON