Vigade viited

Kõik qr3.app API vead järgivad RFC 7807 Problem Details standardit päisega Content-Type: application/problem+json.

{
  "type": "https://docs.qr3.app/errors/not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "QR code qr_xxx not found"
}

`errors/validation`

HTTP 422 Unprocessable Entity

Sisendandmed ei läbinud skeemi valideerimist. Vastus sisaldab massiivi errors koos väljapõhiste üksikasjadega.

{
  "type": "https://docs.qr3.app/errors/validation",
  "title": "Validation Error",
  "status": 422,
  "detail": "Request body validation failed",
  "errors": [
    { "field": "url", "message": "Invalid URL format" }
  ]
}

Põhjused: Puuduvad kohustuslikud väljad, valed andmetüübid, lubatud vahemikust väljaspool olevad väärtused, vigane URL-i vorming.

`errors/bad-request`

HTTP 400 Bad Request

Päringu sisu ei ole kehtiv JSON, kuigi päis Content-Type: application/json on määratud (nt koma pärast viimast elementi, katkestatud või tühi sisu).

`errors/authentication`

HTTP 401 Unauthorized

API-võti puudub, on valesti vormindatud, aegunud või tühistatud.

Lahendus: Kontrolli, kas päis Authorization: Bearer qr3_sk_... on olemas ja võti on aktiivne.

`errors/unauthorized`

HTTP 401 Unauthorized

Sissetulevat veebikonksu (POST /v1/webhooks/clerk, POST /v1/webhooks/eu-registry) kutsuti välja ilma kehtiva allkirja või saladuseta. Puuduva või kehtetu API-võtme korral vastatakse selle asemel veaga errors/authentication.

`errors/authorization`

HTTP 403 Forbidden

API-võti on kehtiv, kuid sellel puudub nõutav skoop (scope) või vajalikud õigused.

`errors/forbidden`

HTTP 403 Forbidden

Ressurss on olemas, kuid kuulub teisele tööruumile (Workspace) või organisatsioonile.

`errors/document-immutable`

HTTP 403 Forbidden

Parameetriga is_immutable üleslaaditud DPP-dokumenti ei saa kustutada.

`errors/not-found`

HTTP 404 Not Found

Soovitud ressurssi ei eksisteeri või see on kustutatud.

`errors/conflict`

HTTP 409 Conflict

Sama kordumatu identifikaatoriga ressurss on juba olemas (nt duplikaat-slug või Idempotency-Key konflikt).

`errors/subscription-exists`

HTTP 409 Conflict

Kutsuti välja POST /v1/billing/checkout, kuigi organisatsioonil on juba tellimus olemas. Muuda selle asemel paketti arveldusportaalis.

`errors/rate-limited`

HTTP 429 Too Many Requests

API-võtme minutipõhine päringulimiit (rate limit) on ületatud. Vastus sisaldab päiseid Retry-After, X-RateLimit-Limit, X-RateLimit-Remaining ja X-RateLimit-Reset.

`errors/rate-limit`

HTTP 429 Too Many Requests

Ressursipõhine päringulimiit on ületatud (nt 200 QR-koodi päeva kohta tööruumi kohta).

`errors/plan-limit`

HTTP 422 Unprocessable Entity

Sinu praegune pakett ei luba seda toimingut (nt DPP-de või dünaamiliste koodide limiit on täis, hulgipäring on liiga suur, liiga palju tööruume või meeskonnaliikmeid). Vajalik on paketi uuendamine.

`errors/invalid-file-type`

HTTP 400 Bad Request

Üleslaaditud faili tüüp ei ole lõpp-punkti poolt toetatud või selle sisu ei vasta deklareeritud Content-Type väärtusele.

`errors/file-too-large`

HTTP 413 Payload Too Large

Üleslaaditud fail ületab paketi või lõpp-punkti lubatud suuruse limiiti.

`errors/storage-limit-exceeded`

HTTP 422 Unprocessable Entity

Üleslaadimine ületaks tööruumi või DPP salvestusruumi kogulimiidi.

`errors/not-configured`

HTTP 503 Service Unavailable

Nõutav teenus või seadistus puudub (nt Stripe on seadistamata, Web Risk API-võti on määramata).

`errors/unsafe-url`

HTTP 422 Unprocessable Entity

URL lükati tagasi, kuna Google Web Risk klassifitseeris selle ebaturvaliseks (pahavara, õngitsemine, sotsiaalne projekteerimine).

`errors/url-flagged`

HTTP 422 Unprocessable Entity

Reserveeritud URL-idele, mis on hilisema perioodilise uuesti skannimise käigus klassifitseeritud ebaturvaliseks.

`errors/already-submitted`

HTTP 409 Conflict

Korduv esitamine — näiteks on selle tööruumi kohta sel kuul juba NPS-skoor esitatud.

`errors/unprocessable-entity`

HTTP 422 Unprocessable Entity

Administraatori toiming pole lubatud (nt teise superadminina esinemine). Seda tüüpi tagastavad ainult superadmini lõpp-punktid.

`errors/request-error`

HTTP 4xx Client Error

Varu-veatüüp kliendipoolsete vigade jaoks, millel puudub täpsem tüüp; olek on vastuses. API-l ei ole praegu ühtegi teadaolevat teed, mis seda tagastaks.

`errors/internal`

HTTP 500 Internal Server Error

Serveris tekkis ootamatu viga. Palun proovi päringut uuesti. Probleemide püsimisel võta ühendust: [email protected].