Autentikointi
Autentikointi
qr3.app käyttää API-avaimia (Bearer-token) autentikointiin. OAuth-työnkulkuja ei ole — luo vain avain ja käytä sitä heti.
API-avaimen luominen
- Kirjaudu sisään osoitteessa app.qr3.app
- Siirry kohtaan Asetukset → API-avaimet
- Klikkaa Uusi avain
- Valitse haluamasi oikeudet (Scopes)
- Kopioi avain — se näytetään vain kerran!
Avaintyypit
| Tyyppi | Etuliite | Käyttö |
|---|---|---|
| Secret Key | qr3_sk_ | Palvelimen puolella (API, Backend) |
| Publishable Key | qr3_pk_ | Asiakkaan puolella (vain lukuoikeus) |
| Test Key | qr3_test_sk_ | Kehitys (omat Rate-Limitit) |
Publishable Key -avaimet (qr3_pk_) eivät saa henkilötietoja. Reitit, jotka palauttavat henkilöiden nimiä, sähköpostiosoitteita tai käyttäjätunnuksia, vastaavat niille koodilla 403: GET /v1/members, GET /v1/workspace/stats/code-creators, GET /v1/audit-logs, GET /v1/organizations, GET /v1/organizations/:id, GET /v1/codes/:id/comments.
Käyttö
HTTP-otsake
Authorization: Bearer qr3_sk_your_key_herecURL
curl https://qr3.app/v1/codes \ -H "Authorization: Bearer qr3_sk_your_key_here"TypeScript SDK
import { QR3 } from "@qr3/sdk";
const client = new QR3({ apiKey: "qr3_sk_your_key_here" });const codes = await client.codes.list();CLI
qr3 login# or:export QR3_API_KEY=qr3_sk_your_key_hereRate Limits
Jokainen API-avain voi lähettää 60 pyyntöä minuutissa kaikissa tilauksissa. Raja koskee avainta kohden, ei työtilaa tai organisaatiota kohden.
Jos raja ylittyy, API palauttaa HTTP-virheen 429:
{ "type": "https://docs.qr3.app/errors/rate-limited", "title": "Too Many Requests", "status": 429, "detail": "Rate limit of 60 requests/minute exceeded for this API key"}Scopes
| Scope | Kuvaus |
|---|---|
* | Täysi pääsy |
codes:read | QR-koodien lukeminen |
codes:write | QR-koodien luominen ja muokkaaminen |
scans:read | Skannaustilastojen lukeminen |
webhooks:write | Webhookien määrittäminen |
account:read | Tilin tietojen lukeminen |