Skip to content
The Collector
Sign in
Developer docs · Changelog

Changelog

What changed in the API, newest first. Deprecations are announced here before a route is retired.

  1. Developer portal, TypeScript SDK, and a fix to the OpenAPI document

    • This portal: the reference, guides, error codes and this changelog.
    • @collector/sdk, a typed client generated from the OpenAPI document (in our repository; not on npm yet).
    • Fixed: the OpenAPI document left out every field and path parameter named id, such as the {id} in /api/v1/public/listings/{id}. The routes themselves were unaffected; their documentation now matches them.

  2. API v1: every route documented

    • Every /api/v1 route is served from a contract, and the OpenAPI 3.1 document at /api/v1/openapi.json is generated from them.
    • Errors are problem documents with a stable code (see Errors); the older error member stays for existing clients.
    • Every response carries X-Request-Id; reads carry an ETag and answer 304 to If-None-Match.
    • Idempotent writes accept Idempotency-Key and replay their first answer for 24 hours.

Coming

  • API keys and scopes for collectors, stores and admins (ENGIN-45)
  • Per-key rate limits and usage (ENGIN-46)
  • Webhooks (ENGIN-50)
  • OAuth for third-party apps (ENGIN-52)