Přeskočit obsah
P
API pro partnery
Napojení vlastní aplikace — přístup, autentizace a endpointy
API pro partnery / Chybové kódy

Chybové kódy#

🔴 Chyby chodí s kódem HTTP 200#

Stavový kód nestačí

Validace, „nenalezeno“, duplicita i konflikt vracejí 200 s success: false. Rozhodujte podle těla odpovědi.

Stavové kódy, které API skutečně používá#

Kód Kdy
200 prakticky vše, včetně aplikačních chyb
204 předběžný CORS dotaz, některé platební návratové adresy
401 chybějící, neplatný, vypršelý nebo zneplatněný token
403 zamítnuté oprávnění
404 neexistující zdroj nebo akce — vrací HTML
429 překročený limit, s hlavičkou Retry-After
500 neošetřená výjimka — vrací HTML

Kódy výsledku#

Číslo v poli code.

Kódy výsledku NEODPOVÍDAJÍ stavovým kódům HTTP

Vypadají podobně a nekorelují. 400 znamená zamítnuté oprávnění, 404 znamená překročený limit, 403 znamená neplatný token.

Nejčastější#

Kód Význam
0 v pořádku
2 validace neprošla
102 uživatel nenalezen
103 není přihlášen
106 relace vypršela
108 neplatné heslo
109 účet není aktivní
110 špatné přihlašovací údaje
400 zamítnuté oprávnění
402 přístupový token vypršel
403 přístupový token je neplatný
404 překročený limit požadavků
602 chybí povinné pole
607 nepovolená operace
616 položka nenalezena

Skupiny#

Rozsah Oblast
100–110 uživatel a přihlášení
200–206 obrázky a soubory
300–304 databáze
400–404 oprávnění a tokeny
500–504 volání API
600–616 data a operace
700–703 úlohy
800–804 zpracování požadavku

Ukázky#

Nepřihlášen (HTTP 401):

{"success":false,"message":"Authentication required","exception":null,"data":null,"code":103}

Zamítnuto (HTTP 403):

{"success":false,"message":"Permission denied","exception":null,"data":null,"code":400}

Limit (HTTP 429, hlavička Retry-After: 240):

{"success":false,"message":"Too many requests, retry in 240s","exception":null,"data":null,"code":404}

Chybí data (HTTP 200):

{"success":false,"code":602,"message":"Missing data"}

Poslední ukázka nemá klíče data ani exception

Obálka není konzistentní. Čtěte jednotlivé klíče obranně.

Neznámý typ filtru#

Překlep v názvu filtru skončí chybou 500, ne validační chybou

A vrátí HTML. Názvy filtrů si ověřte v CRUD vzoru.