Skip to main content

Authentication

Every request requires an API key sent in the x-api-key header:

GET /subscription/equipment HTTP/1.1
Host: api.tracking.cif-consulting.co.uk
x-api-key: <your-api-key>

Requests without a valid key are rejected by the gateway with 403 Forbidden and the body {"message": "Forbidden"}.

Checking your key

GET /account returns identity and usage-plan info for the calling key, which is handy for confirming which environment (live or sandbox) and usage plan a key is scoped to before you build against it. See the Account endpoint for the full response shape.