De API, uitgelegd

De API-documentatie is in het Engels. De parameters zijn dezelfde als in het adres van elk ontwerp.

Every design is a query string: the same parameters as the designer's address. The API takes them, and makes and changes dynamic codes. It comes with Pro, and free for ANBI organisations.

Keys

Make a key on your account page and send it with every request:

curl -H 'Authorization: Bearer qr_…' 'https://qr.dopecode.com/api/v1/codes'

600 requests a minute a key. Answers are JSON, or the file asked for; a problem is JSON with an error.

A design's file

GET https://qr.dopecode.com/api/v1/render?u=example.org&b=fluid&ef=rounded&eb=rounded&format=svg

format: svg, png or pdf

Does it scan?

GET https://qr.dopecode.com/api/v1/check?u=example.org&fg=%23DDDDDD

{"verdict": "unreadable", "worst": null, "meta": { "version": 2, "modules": 25, "ecc": "H",
  "findings": [{ "code": "contrast", "level": "bad", "value": 1.37, "fix": "fg=#6E6E6E" }], … }}

verdict is scans, risky or unreadable: read back at three pixels a module, softened; only large and sharp, or with a warning; not at all. worst is the weakest block's share of its error correction in the best read.

Dynamic codes

GET    https://qr.dopecode.com/api/v1/codes
POST   https://qr.dopecode.com/api/v1/codes          {"target": "https://example.org", "name": "Poster", "design": "b=dots&fg=%2312355B"}
GET    https://qr.dopecode.com/api/v1/codes/7K3QXM   the code and its last 30 days of scans
PATCH  https://qr.dopecode.com/api/v1/codes/7K3QXM   any of target, name, design, state (live or paused)

A code carries its url in capitals, as carries says: the compact alphanumeric mode keeps the code small. Draw it with render, u set to carries and the code's design. A code is never deleted; pause it.

Parameters