Get access
Credentials are made in Developer Studio. Sign in with your ZAITRACK account; the studio works as you, inside your organisation.
Who can do what
What you can change in Developer Studio follows your role in the organisation:
| Action | Needs |
|---|---|
| Create API keys and sandboxes | tenancy:write (owners) |
| Register OAuth apps | identity:write (owners and admins) |
| Create webhooks | webhooks:* (owners and admins) |
| Read OAuth apps, rate limits and your account | any member |
A page you cannot use says which permission you lack.
Your first call
- Create a sandbox. In Developer Studio: Sandboxes → Create a sandbox. An organisation keeps at most three. See Sandboxes and test keys.
- Create a test key. API keys → Create a key, choose test and name the sandbox. Pick the scopes the
integration needs; you cannot grant a scope you do not hold. The key (
zk_test_…) is shown once: store it in your secret manager. - Call the API. A new sandbox is empty, so a list returns no items:
curl "https://api.zaitrack.app/v1/vehicles" \
-H "Authorization: Bearer zk_test_…"
{"items": [], "nextCursor": ""}
- Create something. With
vehicles:write:
curl -X POST "https://api.zaitrack.app/v1/vehicles" \
-H "Authorization: Bearer zk_test_…" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"make": "Volvo", "model": "FH16", "year": 2024, "assetClass": "heavy-truck",
"registration": {"country": "SA", "plate": "ABC 1234"}, "fuelType": "diesel"}'
GET /v1/asset-classes lists the asset classes a vehicle can have. The API reference
gives every field.
Next
- Authentication: API keys, personal access tokens and OAuth apps.
- Errors: what a refusal looks like.
- Recipes: end-to-end tasks on real endpoints.