Collectoh
EN

This page is in English only for now. The main pages follow your choice.

Sign up free
Browse the docs

API reference

Collectoh Plus

Collectoh Plus on this server (P6-20, docs/14 §6): on while the server holds a licence that checks out offline, signed by collectoh.com and not run out. One comes with each daily check-in of a claimed server, good for 30 days without another; an account’s licence key can be pasted in instead, for a server that cannot sign in. Without Plus, what only it does is refused with PLUS_REQUIRED, whose details name the feature; when it lapses nothing is deleted, and what only Plus shows is out of sight until it is back.

Paths are relative to /api/v1 on your server.

GET/plus#

Whether Plus is on here

Everyone may ask whether it is on. Where it comes from — the licence, its account and its expiry, the last check-in’s word, a pasted key and what is wrong with it — is for those with settings:manage; others are sent nulls.

Authorisation
Bearer token or API key · Session cookie
  • 200Success. application/json · PlusStatus
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks library:view, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope
POST/plus/check#

Check in now

Asks Collectoh accounts about Plus now rather than at tomorrow’s check-in: what the app does while its owner buys Plus, so it switches on within seconds. However often it is asked, a check-in goes out once in ten seconds at most.

Authorisation
Bearer token or API key · Session cookie
  • 200Success. application/json · PlusStatus
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks settings:manage, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope
POST/plus/key#

Paste in the account’s licence key

For a server that cannot sign in: the key collectoh.com shows an account with Plus. It is checked here, offline, before it is kept.

Authorisation
Bearer token or API key · Session cookie
Body
application/json · object
  • 200Success. application/json · PlusStatus
  • 400VALIDATION_FAILED: the request did not match the schema; details.issues lists what. LICENCE_INVALID: Not a licence key this server takes: altered, signed by someone else, run out, or not a key. details.reason says which. application/json · ErrorEnvelope
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks settings:manage, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope
DELETE/plus/key#

Take the licence key out

Authorisation
Bearer token or API key · Session cookie
  • 200Success. application/json · PlusStatus
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks settings:manage, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope