Getting started

Every Cazana API request needs two things: a base URL for the environment you are targeting, and your API key. This page covers both, then walks through a first call.

Environments

The API runs in two environments. Most integrations build against UAT first, then switch the base URL to Production to go live. The key you are issued is tied to an environment.

Authentication

Your API key is issued by Cazana and must be sent with every request, as an Authorization header with a bearer prefix:

curl --request GET \
  --url 'https://api.cazana.com/spec/1.2?vrm=AB12CDE' \
  --header 'Authorization: bearer YOUR_API_KEY'

A key query parameter is also supported, but prefer the header so your key stays out of URLs and logs.

Identifying a vehicle

Most endpoints accept either a VRM (number plate) or a VIN. Pass whichever you hold:

curl --request GET \
  --url 'https://api.cazana.com/spec/1.2?vrm=AB12CDE' \
  --header 'Authorization: bearer YOUR_API_KEY'

curl --request GET \
  --url 'https://api.cazana.com/spec/1.2?vin=SALGA2BU8HA000000' \
  --header 'Authorization: bearer YOUR_API_KEY'

See VRM and VIN for the difference.

Errors

Errors share a consistent shape across the API.