API changelog

Changes to anything on this hub are recorded here. A stable endpoint cannot break without an entry here first and a deprecation window; a beta endpoint cannot break without an entry here at all.

Additive changes — a new optional field, a new endpoint — are noted but do not need notice.

Unreleased

• API keys. Organisations create keys under Settings → API Keys. A key authenticates the new /api/v1 API from a server, read only or read and write. See authentication.
• /api/v1 documented as beta: retrieve the organisation, list and retrieve orders, create an order, list a day's jobs and retrieve a job.
• Webhooks for order.created, order.cancelled, job.started, job.completed and job.failed, signed with HMAC-SHA256. See webhooks.
• Developer hub published. First public description of the booking widget, the hosted booking page and the public catalogue.
• API reference is its own hub at /api, with a nested sidebar (introduction, then catalogue, orders and hosted payments) rather than a single scrolling page of every endpoint.
• GET /api/public/{organisation}/catalog documented as stable.
• POST /api/public/{organisation}/orders documented as beta while the origin allowlist remains the only way to authorise a write.