ePostman docs
PortálConsole

Zoznam endpointovEndpoints

Prehľad SAPI-SK a Enterprise API endpointov s odkazom na interaktívnu dokumentáciu.Overview of the SAPI-SK and Enterprise API endpoints, with a link to the interactive documentation.

2 min čítania2 min read
  • #sapi-sk
  • #enterprise api
  • #endpointy
  • #openapi
  • #sapi-sk
  • #enterprise api
  • #endpoints
  • #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.

štandard

SAPI-SK

Osem endpointov štandardizovaného rozhrania, interaktívne.

/docs/#sapiplatforma

Enterprise API

Faktúry, webhooky, notifikácie, kredit a správa organizácie.

/docs/#enterprise

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

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 v archíve
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.

An overview follows. The full reference — schemas, examples and a Try it button — lives in the interactive documentation.

standard

SAPI-SK

Eight endpoints of the standardised interface, interactive.

/docs/#sapiplatform

Enterprise API

Invoices, webhooks, notifications, credit and organisation management.

/docs/#enterprise

SAPI-SK standard

MethodEndpointDescription
POST/sapi/auth/tokenIssues an access token
POST/sapi/auth/renewRenews a token with the refresh_token
POST/sapi/auth/revokeRevokes a token
GET/sapi/auth/token/statusReports validity and whether a refresh is due
POST/sapi/document/sendSends a document into the Peppol network
GET/sapi/document/receiveLists inbound documents
GET/sapi/document/receive/{id}Returns the inbound document as JSON (XML in the payload)
POST/sapi/document/receive/{id}/acknowledgeAcknowledges the document

Enterprise API

MethodEndpointDescription
POST/api/v1/invoicesCreates and sends an invoice
GET/api/v1/invoicesLists invoices, cursor-paginated
GET/api/v1/invoices/{id}Invoice detail including status
GET/api/v1/invoices/{id}/xmlThe original UBL XML
GET/api/v1/invoices/{id}/pdfPDF rendering of the invoice
GET/api/v1/invoices/searchFull-text search across the archive
DELETE/api/v1/invoices/{id}Cancels an invoice while still PENDING or VALIDATING
POST/api/v1/documents/validatePre-flight validation of a document — no send, no credit
GET/api/v1/participants/{peppolId}/reachabilityReports whether the receiver is in the network and supports the document type
POST/api/v1/webhooksRegisters a webhook
POST/api/v1/webhooks/{id}/testSends a test event
GET/api/v1/billing/balanceCredit balance
POST/api/v1/sapi-clientsCreates a SAPI client

documents/validate and participants/{peppolId}/reachability cover the pre-flight check: they validate the document and the receiver’s reachability, create no invoice and consume no credit. The response shape, the meaning of reason and the limits are covered in Pre-flight validation.