Formáty API odpovědí
Přehled formátů API odpovědí a datových struktur. Všechny endpointy vrací standardizovaný JSON s indikátorem úspěchu a zprávou. Seznamové endpointy podporují stránkování.
Brzy doplníme screenshoty a podrobnější návod.
Standardní odpověď
Většina API endpointů vrací standardní odpověď s poli: 'success' (boolean — zda operace proběhla úspěšně) a 'message' (string — textová zpráva o výsledku, zejména při chybě). Některé endpointy vracejí rozšířenou odpověď s polem 'result' obsahujícím objekt s výslednými daty (např. vytvořenou fakturu nebo extrahovaná data).
Stránkovaný seznam
Seznamový endpoint /api/invoice-isdoc vrací odpověď s poli: 'items' (pole objektů faktur s kompletními daty), 'hasMore' (boolean — zda existují další záznamy za aktuální stránkou), 'totalCount' (celkový počet záznamů v databázi). Stránkování se řídí parametry 'offset' (od kterého záznamu) a 'limit' (kolik záznamů, výchozí 25).