ZačínameStránkovanie a chyby

Stránkovanie a chyby

Načítanie ďalších strán, aplikačné kódy a limity API.

Stránkovanie dokladov

Pri POST /v2/documents používajte searchAfter:

  1. Prvú požiadavku pošlite bez data.searchAfter a nastavte zoradenie, napríklad orderBy: "issue_date".
  2. Spracujte vrátené doklady.
  3. Ak odpoveď obsahuje neprázdne searchAfter, preneste celé pole bez úprav do data.searchAfter nasledujúcej požiadavky. Zachovajte organizáciu, filtre aj zoradenie.
  4. Pri APP_NO_MORE_DATA ukončite načítanie. Ak chýba ďalší token alebo sa token opakuje, neposielajte rovnakú požiadavku v nekonečnej slučke.

Pole continuationToken je v tejto schéme označené ako zastarané.

Pre /v2/documents špecifikácia uvádza limit 2 000 exportovaných dokladov na požiadavku. Pri APP_MAX_EXPORT_LIMIT_EXCEEDED zúžte rozsah filtrov, napríklad obdobie.

Bankové transakcie majú vlastnú schému stránkovania. Ich searchAfter môže obsahovať reťazce aj čísla; zachovajte pôvodné typy hodnôt.

HTTP a aplikačné chyby

Kontrolujte HTTP status aj JSON odpoveď. Štruktúra a dostupné kódy sa líšia podľa endpointu.

Stav alebo kódVýznam a ďalší postup
HTTP 403Požiadavka nie je autorizovaná. Skontrolujte kľúč a oprávnenia.
HTTP 404Požadovaný zdroj sa nenašiel. Overte cestu a identifikátory.
HTTP 500Chyba servera. Zaznamenajte čas a odpoveď pre diagnostiku bez API kľúča.
APP_UNAUTHENTICATEDSkontrolujte autentifikáciu hlavičkou api_key.
APP_INCORRECT_INPUT_DATAOverte vstupné polia, filtre, typy a povolené hodnoty podľa schémy.
APP_ORGANIZATION_NOT_FOUND_CODEOrganizácia podľa zadaného IČO sa nenašla.
APP_MAX_EXPORT_LIMIT_EXCEEDEDZúžte rozsah exportu dokladov.
APP_READ_DATA_ERRORChyba pri načítaní údajov.
APP_NO_MORE_DATAKoniec dostupných údajov pri načítavaní dokladov.

Limity API prepojenia

Podľa návodu API prepojenia API po vyčerpaní nastaveného denného alebo mesačného limitu vráti HTTP 429 Too Many Requests. Odpoveď obsahuje informáciu o prekročenom limite. Takto odmietnuté požiadavky sa v Histórii aktivity nezobrazia.

Limity využitia API kľúča sú odlišné od limitu počtu dokladov na jednu exportnú požiadavku. Počet jednotiek za jednotlivé operácie a pravidlá pri chybách nájdete na stránke Pricing.

Opakovanie požiadaviek

Pri dočasnej chybe načítania odporúčame obmedzený počet opakovaní s rastúcim odstupom. Po chybe autentifikácie alebo vstupu najskôr opravte príčinu.

Pri vystavení faktúry, odoslaní emailu alebo inej zmene údajov neodosielajte požiadavku po timeoute automaticky znova. Najskôr overte výsledný stav; špecifikácia negarantuje idempotenciu ani nedefinuje idempotency key.

Zdroj technických parametrov: OpenAPI špecifikácia Doklado.