API reference
ZAITRACK's public API v1: 158 operations at https://api.zaitrack.app, generated from the gateway's route table.
Every operation below exists at the gateway and reaches a service that serves it.
Shapes and where they come from
Each operation names its request and response fields. They come from the service's handler, read from its source, or from its OpenAPI document where the handler cannot be read. Where neither describes a body, the page says Not described rather than guess.
- Request bodies: 70 described, 88 have no body, 0 not described.
- Responses: 142 described, 6 have no body, 8 not described.
Scopes
A credential reaches an operation when it holds the scope, or the scope's family with *
(vehicles:* covers vehicles:read and vehicles:write). 3 operations need only a signed-in caller
and 4 need no credential.
| Scope | Operations that need it |
|---|---|
alerts:read | 4 |
alerts:write | 5 |
commands:approve | 2 |
commands:read | 4 |
commands:write | 6 |
devices:read | 4 |
devices:write | 6 |
dispatch:read | 3 |
dispatch:write | 7 |
drivers:read | 3 |
drivers:write | 8 |
fuel:read | 10 |
fuel:write | 10 |
geofences:read | 5 |
geofences:write | 3 |
maintenance:read | 9 |
maintenance:write | 10 |
reports:read | 6 |
reports:run | 2 |
reports:write | 3 |
rules:read | 1 |
rules:write | 3 |
telemetry:read | 2 |
tenancy:read | 1 |
tenancy:write | 2 |
trailers:read | 2 |
trips:read | 2 |
vehicles:read | 6 |
vehicles:write | 9 |
webhooks:read | 6 |
webhooks:write | 7 |
Rate classes
Each operation has one class. Its limits count your organisation's requests to that operation, across all
your credentials, in your region. A request over a limit gets 429. See Rate limits.
| Class | Limit per organisation |
|---|---|
read | 100 per second and 360,000 per hour |
write | 50 per second and 36,000 per hour |
telemetry | 10 per second and 180,000 per hour |
command | 20 per second and 360,000 per hour |
bulk | 100 per hour |
report | 1,000 per day |
credentials | 10 per minute |
public | 100 per second and 360,000 per hour (per client IP) |