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

StatusMeaning
401Missing, invalid or revoked key
403Key not allowed from this IP, not scoped for this service, or account suspended
404Unknown service or endpoint
405Only GET is supported
429Rate limit reached
502 / 503The 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.

EndpointReturns
GET/statusConnection state and record counts
GET/kpisTotals: open, won, closed, win rate, order value
GET/trend?days=30Requests and wins per day
GET/top-parts?limit=20Most requested parts
GET/opportunities?limit=48Parts in demand, scored against stock, with a suggested action
GET/procurementsRequests and orders. Filters: status, outcome, part, limit (max 500), offset
GET/procurements/{id}One request with buyer, vehicle, parts and timeline
GET/dashboardHTML dashboard for embedding in your own logged-in portal

Parts Trader

Base: /v1/parts-trader.

EndpointReturns
GET/notificationsIncoming quote requests
GET/statsSummary statistics
GET/trends, /trends/detailDemand trends
GET/top-sellingTop-selling parts
GET/quotesQuote history and outcomes
GET/procurement-advisorWhat to stock, based on demand
GET/vehicle-suggestionsVehicles worth sourcing
GET/requests/{guid}/parts-stockStock matches for one request
GET/reports/csv, /reports/pdfDemand report downloads

Questions? [email protected]