v1 API contract. New fields may appear at any time (your code should ignore what it doesn’t know); a breaking change would ship as v2.
v1
Production address: the API answers at
https://needalert.app/api/v1. The OpenAPI servers and the guides’ examples use this address; there is no api. subdomain.Items: in the list filter, an empty or null external_reference is ignored instead of answering 422.Dispatches: the 429 description of POST …/items/{item}/events explains that the dispatch budget counts every attempt on the route, including ones refused with 404, 403 or 422, and that the X-RateLimit-* headers report the budget with fewer requests left.Credits: each statement line’s description comes in the request’s language for the lines the platform writes itself; a manual adjustment keeps the text it was written with.v1
First release of the public API, with API keys created in the dashboard (Integrations screen) and
Authorization: Bearer authentication.Units: list and read the key’s units.Items: list (with an exact external_reference filter), create, read, update, archive, upload and remove the picture, get the QR code.Dispatches: estimate the cost, send or schedule, list, read, reschedule and cancel.Credits: the chain’s balance and statement.For machines: Idempotency-Key on POST …/items and POST …/items/{item}/events (24 hours), Accept-Language defaulting to the chain’s language, X-Request-Id, limits of 300 requests and 60 dispatches per minute per key.