API reference / Collectors
Signed access to catalog covers, and covers prepared for printed labels.
/api/v1/covers/tokenLets a signed-in client load catalog covers it reads straight from the database: append it to covers.collection.id URLs as ?t=<token> (the covers edge refuses unsigned requests). Valid 1–2 days; refresh every few hours.
collector.getCoverToken()catalog:read(API keys are coming soon)X-Request-Idobject
tokenstring or nullrequiredAppend as ?t= to covers.collection.id URLs; null when covers aren’t signed here.
expiresAtstring (date-time) or nullrequiredunauthorized: Not signed in (no session or token, or an expired one).
internal: Something went wrong on our side (quote the requestId).
curl 'https://collection.id/api/v1/covers/token' \
-H "Authorization: Bearer $COLLECTOR_TOKEN"await collector.getCoverToken();/api/v1/labels/coverA catalog cover as a 2:3 JPEG, for a label PDF (PDFs embed only JPEG and PNG, and the covers origin doesn’t answer cross-origin fetches). Catalog cover URLs only. 1,200 every 10 minutes.
collector.getLabelCover()labels:read(API keys are coming soon)X-Request-Id| Name | In | Type | About |
|---|---|---|---|
srcrequired | query | string (uri) | The catalog cover’s URL. |
woptional | query | string | Width in pixels, 60–600 (default 300). |
A file: image/jpeg
invalid_request: The query or body doesn’t match the schema (see errors[]).
unauthorized: Not signed in (no session or token, or an expired one).
not_found: That cover isn’t available.
too_large: The cover is over 15 MB.
unreadable: The cover couldn’t be read as an image.
rate_limited: More than 1,200 covers in 10 minutes; wait the Retry-After seconds.
internal: Something went wrong on our side (quote the requestId).
curl 'https://collection.id/api/v1/labels/cover' \
-H "Authorization: Bearer $COLLECTOR_TOKEN"await collector.getLabelCover({ query: { … } });