Kļūdas

GetQR API ir beta versijā un pieejams atlasītām darbvietām. Līdz vispārējai izlaišanai detaļas var mainīties.

GetQR API izmanto standarta HTTP statusa kodus. Veiksmīgi pieprasījumi atgriež 2xx. Neveiksmīgi pieprasījumi atgriež 4xx vai 5xx ar JSON pamattekstu, kas paskaidro, kas nogāja greizi.

Kļūdas formāts

Katrai kļūdai ir viena un tā pati forma: stabils kods, cilvēkam saprotams ziņojums un saite uz šī koda aprakstu.

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized: Invalid API key.",
    "doc_url": "https://getqr.com/account/api-docs#error-unauthorized"
  }
}

string

obligāts

Stabils, mašīnlasāms kļūdas kods. Izmantojiet to savā kodā ziņojuma vietā. Skatiet Kļūdu kodi.

string

obligāts

Cilvēkam saprotams problēmas apraksts. Formulējums var mainīties.

string

obligāts

Saite uz kļūdas koda aprakstu API dokumentācijā jūsu GetQR kontā.

Kļūdu kodi

Kods	HTTP statuss	Kad tas notiek
`bad_request`	400	Pieprasījums ir nepareizi veidots: pamatteksts nav derīgs JSON, galvenē `Authorization` trūkst prefiksa `Bearer` vai darbība nav atļauta resursa pašreizējā stāvoklī (piemēram, pabeigtas lielapjoma izveides atcelšana).
`unauthorized`	401	API atslēga trūkst vai nav derīga, piemēram, tāpēc, ka tā tika pārģenerēta.
`forbidden`	403	Darbvietas īpašnieka abonements nav aktīvs, vai jūsu loma darbvietā šo darbību neatļauj.
`exceeded_limit`	403	Sasniegts plāna ierobežojums. Plānā Single QR: QR koda izveide vai dublēšana, ja darbvietā jau ir viens, vai lielapjoma izveides sākšana.
`not_found`	404	Resurss neeksistē vai nav jūsu darbvietā, galapunkts neeksistē, vai API jūsu darbvietai nav iespējots.
`method_not_allowed`	405	Galapunkts eksistē, bet nepieņem šo HTTP metodi. Galvene `Allow` uzskaita metodes, ko tas pieņem.
`conflict`	409	Pieprasījums ir pretrunā ar esošajiem datiem: īsās saites slug ir aizņemts, pieprasījums ar to pašu `Idempotency-Key` vēl tiek apstrādāts, grafiks pārklājas ar esošu vai lielapjoma arhīvs vēl nav gatavs.
`invite_pending`	409	Jūs tikāt uzaicināts uz darbvietu, bet vēl neesat pievienojies. API atslēgas pieprasījumi to neatgriež: atslēgas darbvieta vienmēr ir tāda, kurai jūs piederat.
`invite_expired`	410	Jūsu uzaicinājumam uz darbvietu ir beidzies derīgums. API atslēgas pieprasījumi to neatgriež tā paša iemesla dēļ.
`unprocessable_entity`	422	Pamatteksts vai vaicājuma parametri neizturēja validāciju. Ziņojumā ir norādīts lauks un tas, kas ar to nav kārtībā. Skatiet Validācijas kļūdas.
`rate_limit_exceeded`	429	API atslēga ir izlietojusi pašreizējā loga pieprasījumus. Skatiet Pieprasījumu ierobežojumi.
`internal_server_error`	500	Mūsu pusē kaut kas nogāja greizi. Mēģiniet vēlreiz vēlāk un sazinieties ar atbalstu, ja tas atkārtojas.

Validācijas kļūdas

Ja pamatteksts vai vaicājuma parametri neiztur validāciju, API atbild ar 422. Ziņojums apraksta pirmo nederīgo lauku formā <issue>: <field>: <details>:

{
  "error": {
    "code": "unprocessable_entity",
    "message": "too_big: pageSize: Max page size is 100.",
    "doc_url": "https://getqr.com/account/api-docs#error-unprocessable_entity"
  }
}

Ligzdotiem laukiem tiek izmantots punktu pieraksts, piemēram, link.url.

Kļūdu apstrāde

Pieņemiet lēmumus pēc error.code, nevis pēc error.message.
Neatkārtojiet 4xx kļūdas nemainītas: vispirms izlabojiet pieprasījumu. Izņēmumi ir 409 pieprasījumam, kas vēl tiek apstrādāts, un 429.
Pie 429 pagaidiet tik sekundes, cik norādīts galvenē Retry-After. Skatiet Pieprasījumu ierobežojumi.
Atkārtojiet 5xx kļūdas ar eksponenciālu aizturi.

Biežākās problēmas

Katrs pieprasījums atgriež 404 "This endpoint is not available."

API ir beta versijā, un jūsu darbvietai tas vēl nav iespējots.

404 "This endpoint does not exist."

Ceļš ir nepareizs. Salīdziniet to ar galapunktu lapām un pārbaudiet, vai tas sākas ar /api/v1/.

403 "Access denied: This account does not have an active subscription."

Darbvietas īpašnieka abonements ir beidzies. API atslēga atkal darbojas, tiklīdz īpašnieks atjauno abonementu.

403 "API access is not available for this role."

Jūsu loma darbvietā ir skatītājs. API var izmantot tikai darbvietas īpašnieks un redaktori.

API

Kļūdas formāts

Kļūdu kodi

Validācijas kļūdas

Kļūdu apstrāde

Biežākās problēmas

Kas tālāk

Pieprasījumu ierobežojumi

Autentifikācija

​Kļūdas formāts

​Kļūdu kodi

​Validācijas kļūdas

​Kļūdu apstrāde

​Biežākās problēmas

​Kas tālāk

Pieprasījumu ierobežojumi

Autentifikācija

Kļūdas formāts

Kļūdu kodi

Validācijas kļūdas

Kļūdu apstrāde

Biežākās problēmas

Kas tālāk