Developer docs · Overview
Build with The Collector
The API our web and native apps are built on: the catalog, collections, shops and admin. This reference is generated from the same route contracts that serve each request, so it can’t drift from what the API does.
Status
- Version
- v1, stable. Breaking changes go to v2.
- Documented
- 182 operations in 31 groups; 116 stable, 66 beta.
- API keys
- Coming soon. Until then, signed-in routes take a signed-in session.
The OpenAPI 3.1 document: /api/v1/openapi.json
What you can build
Collector tools
Read the public catalog, shops and profiles without signing in. With a collector’s credentials, work with their own collection: scans, copies, values, price alerts and exports.
/api/v1/public/catalog/search?q=sagaShop inventory sync
Keep a shop’s shelves in step with its point of sale: preview a CSV against the catalog, commit the rows that matched, update listings, and answer holds and questions.
/api/v1/stores/{storeId}/import/previewAdmin scripting
Script what Admin does: edit catalog records with field locks, merge duplicates after a dry-run preview (and undo them), and work the moderation queues.
/api/v1/admin/merges/previewYour first call
Public routes need no credentials. Search the catalog:
curl 'https://collection.id/api/v1/public/catalog/search?q=saga'Then follow the Quickstart, or browse the API reference.
Guides
- Quickstart
Your first request with curl and with the TypeScript SDK.
- Authentication and scopes
Sessions, access tokens, API keys and the scopes each operation needs.
- Pagination, filtering and sorting
Cursors, the few routes that page another way, filters and sort orders.
- Retries and idempotency
Idempotency-Key, which writes are safe to retry, and Retry-After.
- Rate limitsComing
What’s limited today, and the per-key limits coming with ENGIN-46.
- Versioning and deprecation
What v1 promises, beta routes, and how a route is retired.
- WebhooksComing
Signed event delivery, coming with ENGIN-50.
- Barcodes
UPC and its add-on, EAN and ISBN, and how a barcode becomes an edition.
- Stores: inventory sync
Listing a shop’s stock from a CSV or one book at a time.
- Admin: scripting safely
Dry runs, undo, idempotent writes and the audit log.
- Errors
The problem format, and every error code the API answers.