ePostman docs
Portál

Zoznam endpointov

Prehľad SAPI-SK a Enterprise API endpointov s odkazom na interaktívnu dokumentáciu.

2 min čítania
  • #sapi-sk
  • #enterprise api
  • #endpointy
  • #openapi

Nižšie je prehľad. Úplnú referenciu vrátane schém, príkladov a tlačidla Try it nájdete v interaktívnej dokumentácii.

SAPI-SK štandard

MetódaEndpointPopis
POST/sapi/auth/tokenVydá prístupový token
POST/sapi/auth/renewObnoví token cez refresh_token
POST/sapi/auth/revokeZneplatní token
GET/sapi/auth/token/statusZistí platnosť a či je čas na obnovu
POST/sapi/document/sendOdošle dokument do siete Peppol
GET/sapi/document/receiveZoznam prijatých dokumentov
GET/sapi/document/receive/{id}Vráti prijatý dokument ako JSON (XML v poli payload)
POST/sapi/document/receive/{id}/acknowledgePotvrdí prevzatie dokumentu
GET/sapi/healthStav služby bez autentifikácie — rovnaké telo ako /health (200 / 503)

Enterprise API

MetódaEndpointPopis
POST/api/v1/invoicesVytvorí a odošle faktúru
GET/api/v1/invoicesZoznam faktúr, stránkovaný kurzorom
GET/api/v1/invoices/{id}Detail faktúry vrátane stavu
GET/api/v1/invoices/{id}/xmlPôvodné UBL XML
GET/api/v1/invoices/{id}/pdfPDF vizualizácia faktúry
GET/api/v1/invoices/searchFulltextové vyhľadávanie faktúr, stránkované kurzorom; s scope=archive namiesto aktuálnych v archivovaných faktúrach
DELETE/api/v1/invoices/{id}Zruší faktúru, kým je PENDING alebo VALIDATING
POST/api/v1/documents/validatePredbežná validácia dokumentu — bez odoslania, bez kreditu
GET/api/v1/participants/{peppolId}/reachabilityOverí, či je príjemca v sieti a podporuje daný typ dokumentu
POST/api/v1/webhooksZaregistruje webhook
POST/api/v1/webhooks/{id}/testPošle testovaciu udalosť
GET/api/v1/billing/balanceZostatok kreditu
POST/api/v1/sapi-clientsVytvorí SAPI klienta

documents/validate a participants/{peppolId}/reachability slúžia na kontrolu pred odoslaním: overia dokument aj dosiahnuteľnosť príjemcu, nevytvárajú faktúru a nespotrebúvajú kredit. Tvar odpovede, význam poľa reason a limity rozoberá článok Predbežná validácia.