Tagairt Earráidí

Leanann gach earráid API de chuid qr3.app RFC 7807 Problem Details le 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

Theip ar bhailíochtú scéime na sonraí ionchuir. Tá eagar errors sa fhreagairt le sonraí cruinne faoi gach réimse.

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

Cúiseanna: Réimsí riachtanacha ar iarraidh, cineálacha sonraí míchearta, luachanna lasmuigh den raon ceadaithe, formáid URL neamhbhailí.

`errors/bad-request`

HTTP 400 Bad Request

Ní JSON bailí é an corp cé go bhfuil Content-Type: application/json socraithe (m.sh. camóg chun deiridh, corp teasctha nó corp folamh).

`errors/authentication`

HTTP 401 Unauthorized

Tá an eochair API ar iarraidh, formáidithe go mícheart, as dáta nó cúlghairthe.

Réiteach: Seiceáil an bhfuil an ceanntásc Authorization: Bearer qr3_sk_... i láthair agus an bhfuil an eochair gníomhach.

`errors/unauthorized`

HTTP 401 Unauthorized

Glaodh ar webhook isteach (POST /v1/webhooks/clerk, POST /v1/webhooks/eu-registry) gan síniú nó rún bailí. Freagraíonn eochair API ar iarraidh nó neamhbhailí le errors/authentication ina ionad sin.

`errors/authorization`

HTTP 403 Forbidden

Tá an eochair API bailí, ach níl an scóip riachtanach nó an cead cuí aici.

`errors/forbidden`

HTTP 403 Forbidden

Tá an acmhainn ann, ach baineann sí le Workspace eile nó le heagraíocht eile.

`errors/document-immutable`

HTTP 403 Forbidden

Ní féidir doiciméad DPP a uaslódáladh le is_immutable a scriosadh.

`errors/not-found`

HTTP 404 Not Found

Níl an acmhainn iarrtha ann nó scriosadh í.

`errors/conflict`

HTTP 409 Conflict

Tá acmhainn leis an aitheantóir uathúil céanna ann cheana féin (m.sh. slug dúbailte nó imbhualadh Idempotency-Key).

`errors/subscription-exists`

HTTP 409 Conflict

Glaodh ar POST /v1/billing/checkout cé go bhfuil síntiús ag an eagraíocht cheana féin. Athraigh an plean sa phainéal billeála ina ionad sin.

`errors/rate-limited`

HTTP 429 Too Many Requests

Sáraíodh teorainn ráta in aghaidh an nóiméid na heochrach API. Tá na ceanntásca Retry-After, X-RateLimit-Limit, X-RateLimit-Remaining agus X-RateLimit-Reset sa fhreagairt.

`errors/rate-limit`

HTTP 429 Too Many Requests

Sáraíodh teorainn ráta a bhaineann go sonrach le hacmhainn (m.sh. 200 cód QR in aghaidh an lae in aghaidh an Workspace).

`errors/plan-limit`

HTTP 422 Unprocessable Entity

Ní cheadaíonn do phlean reatha an gníomh seo (m.sh. cuóta DPPanna nó cóid dhinimiciúla ídithe, baisc ró-mhór, an iomarca Workspaces nó ball foirne). Tá uasghrádú ag teastáil.

`errors/invalid-file-type`

HTTP 400 Bad Request

Tá cineál ag an gcomhad uaslódáilte nach nglacann an críochphointe leis, nó ní thagann a ábhar leis an Content-Type dearbhaithe.

`errors/file-too-large`

HTTP 413 Payload Too Large

Sáraíonn an comhad uaslódáilte teorainn mhéide an phlean nó an chríochphointe.

`errors/storage-limit-exceeded`

HTTP 422 Unprocessable Entity

Sháródh an uaslódáil stóráil iomlán an Workspace nó an DPP.

`errors/not-configured`

HTTP 503 Service Unavailable

Tá seirbhís riachtanach nó cumraíocht ar iarraidh (m.sh. Stripe gan chumrú, eochair API Web Risk gan socrú).

`errors/unsafe-url`

HTTP 422 Unprocessable Entity

Diúltaíodh don URL toisc gur mheas Google Web Risk go raibh sé neamhshábháilte (earraí mailíseacha, fioscaireacht, innealtóireacht shóisialta).

`errors/url-flagged`

HTTP 422 Unprocessable Entity

Forchoimeádta do URLanna a rangaíodh mar neamhshábháilte níos déanaí le linn athscanta tréimhsiúil.

`errors/already-submitted`

HTTP 409 Conflict

Aighneacht dhúbailte — m.sh. cuireadh scór NPS isteach don Workspace seo cheana féin an mhí seo.

`errors/unprocessable-entity`

HTTP 422 Unprocessable Entity

Gníomh riaracháin nach bhfuil ceadaithe (m.sh. aithris a dhéanamh ar superadmin eile). Ní sheolann ach críochphointí an superadmin an cineál seo ar ais.

`errors/request-error`

HTTP 4xx Client Error

Cúltaca le haghaidh earráidí cliant nach bhfuil cineál níos sonraithe acu; tá an stádas sa fhreagra. Níl aon chonair ar eolas ag an API faoi láthair a sheolann é seo ar ais.

`errors/internal`

HTTP 500 Internal Server Error

Earráid gan choinne ar an bhfreastalaí. Déan iarracht eile leis an iarratas, le do thoil. Má leanann an fhadhb: [email protected].