Práca s eFaktúramiPrehľad endpointov

Prehľad endpointov SAPI+

Prehľad 9 verejných operácií Doklado SAPI a SAPI+.

Referencia pokrýva 9 verejných operácií Doklado SAPI a SAPI+. Základný server a cesty sú uvedené v prehľade SAPI+. Názvy operácií v REST API referencii začínajú veľkým písmenom.

MetódaEndpointÚčel
POST/v1/sapi/auth/tokenZískanie access tokenu
GET/v1/sapi/auth/token/statusKontrola platnosti tokenu
POST/v1/sapi/auth/renewObnova tokenu
POST/v1/sapi/auth/revokeZrušenie tokenu
POST/v1/sapi/document/sendOdoslanie XML eFaktúry
GET/v1/sapi/document/receiveZoznam prijatých dokumentov
GET/v1/sapi/document/receive/{documentId}Detail a XML dokumentu
POST/v1/sapi/document/receive/{documentId}/acknowledgePotvrdenie úspešného prevzatia
GET/v1/sapi-plus/participant/lookupVyhľadanie účastníka podľa DIČ

Rozsah verejného rozhrania

renew obnovuje token pomocou refresh_token; revoke slúži na jeho zrušenie. Príklady požiadaviek nájdete v návode Autentifikácia a tokeny. Klientské prístupy získate pri aktivácii.

Dokumentové operácie patria do SAPI (/v1/sapi/document/...). Jediným verejným SAPI+ endpointom v aktuálnej referencii je vyhľadanie účastníka GET /v1/sapi-plus/participant/lookup. Interná verifikácia pre webovú aplikáciu nie je súčasťou verejného rozhrania.

Referencia neobsahuje samostatný endpoint na stav odoslaného dokumentu, správu webhookov ani ich testovanie.

Webhook je odchádzajúci POST z Doklado na URL klienta. Jeho štruktúra je v návode Webhooky; nejde o ďalší endpoint na API serveri Doklado.

Ako čítať referenciu

Referencia uvádza vstupy operácií, popisy polí a príklady odpovedí. Pri obnove a zrušení tokenu nie je formát odpovedí v aktuálnych podkladoch definovaný. Príklady identifikátorov a XML nahraďte vlastnými platnými údajmi.