Skip to content

Autentimine

Autentimine

qr3.app kasutab autentimiseks API-võtmeid (Bearer-token). OAuth-vooge ei ole — loo lihtsalt võti ja kasuta kohe.

API-võtme loomine

  1. Logi sisse aadressil app.qr3.app
  2. Mine Seaded → API-võtmed
  3. Klõpsa Uus võti
  4. Vali soovitud õigused (skoobid)
  5. Kopeeri võti — seda kuvatakse ainult üks kord!

Võtmete tüübid

TüüpPrefiksKasutus
Secret Keyqr3_sk_Serveripoolne (API, backend)
Publishable Keyqr3_pk_Kliendipoolne (ainult lugemisõigus)
Test Keyqr3_test_sk_Arendus (eraldi päringupiirangud)

Publishable Key tüüpi võtmed (qr3_pk_) ei saa isikuandmeid. Marsruudid, mis tagastavad inimeste nimesid, e-posti aadresse või kasutaja-ID-sid, vastavad neile koodiga 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.

Kasutamine

HTTP-päis

Authorization: Bearer qr3_sk_your_key_here

cURL

Terminal window
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

Terminal window
qr3 login
# or:
export QR3_API_KEY=qr3_sk_your_key_here

Päringupiirangud

Iga API-võti võib saata 60 päringut minutis, kõigis pakettides. Piirang kehtib võtme kohta, mitte tööruumi või organisatsiooni kohta.

Piirangu ületamisel tagastab API HTTP-koodi 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"
}

Skoobid

SkoopKirjeldus
*Täielik juurdepääs
codes:readQR-koodide lugemine
codes:writeQR-koodide loomine ja muutmine
scans:readSkaneerimisstatistika lugemine
webhooks:writeVeebikonksude seadistamine
account:readKonto andmete lugemine