API reference
All endpoints are GET requests to https://api.zenoa.nz/v1/ and return JSON unless stated otherwise. The API is read-only.
Authentication
Send your key in the X-Api-Key header (or as Authorization: Bearer <key>). Keys start with zk_live_.
curl https://api.zenoa.nz/v1/partly/kpis \ -H "X-Api-Key: zk_live_YOUR_KEY"
Keep keys on your server. Never put them in a web page, mobile app or public repository. If a key is exposed, ask us to revoke it and we'll issue a new one.
IP allowlist
Every key is locked to the public IP addresses (or ranges) of the servers that call the API. Requests from anywhere else are refused with 403, even with a valid key. Tell us when your servers' addresses change.
Rate limits
Each key has a per-minute limit, 120 requests by default. Above it you'll get 429 with a Retry-After header. Repeated requests with invalid keys from one address are blocked for a while.
Errors
| Status | Meaning |
|---|---|
401 | Missing, invalid or revoked key |
403 | Key not allowed from this IP, not scoped for this service, or account suspended |
404 | Unknown service or endpoint |
405 | Only GET is supported |
429 | Rate limit reached |
502 / 503 | The underlying service is temporarily unavailable |
Error bodies look like {"error": "Missing or invalid API key."}.
Partly
Base: /v1/partly. Optional role=supplier|repairer on the analytics endpoints.
| Endpoint | Returns |
|---|---|
GET/status | Connection state and record counts |
GET/kpis | Totals: open, won, closed, win rate, order value |
GET/trend?days=30 | Requests and wins per day |
GET/top-parts?limit=20 | Most requested parts |
GET/opportunities?limit=48 | Parts in demand, scored against stock, with a suggested action |
GET/procurements | Requests and orders. Filters: status, outcome, part, limit (max 500), offset |
GET/procurements/{id} | One request with buyer, vehicle, parts and timeline |
GET/dashboard | HTML dashboard for embedding in your own logged-in portal |
Parts Trader
Base: /v1/parts-trader.
| Endpoint | Returns |
|---|---|
GET/notifications | Incoming quote requests |
GET/stats | Summary statistics |
GET/trends, /trends/detail | Demand trends |
GET/top-selling | Top-selling parts |
GET/quotes | Quote history and outcomes |
GET/procurement-advisor | What to stock, based on demand |
GET/vehicle-suggestions | Vehicles worth sourcing |
GET/requests/{guid}/parts-stock | Stock matches for one request |
GET/reports/csv, /reports/pdf | Demand report downloads |
Questions? [email protected]