mib:Peppol REST API
Prepojte akýkoľvek fakturačný systém s Peppol sieťou cez náš certifikovaný Access Point.
Peppol pre akýkoľvek systém
Všetko, čo poskytujeme prostredníctvom nášho Access Pointu, je dostupné aj ako REST API — navrhnuté špeciálne pre spoločnosti, ktoré si chcú Peppol integrovať priamo do vlastného systému. Bez ohľadu na to, či používate SAP, vlastný ERP alebo úplne iný fakturačný systém, naše API za vás rieši celú komunikáciu s Peppol sieťou.
API je organizované do štyroch funkčných skupín: autentifikácia, odosielanie faktúr, dobropisy a ťarchopisy a sledovanie stavov dokladov. Každá skupina má jasne definované endpointy, zdokumentované cez OpenAPI a dostupné na priame testovanie cez Swagger.
- check_circle Kompatibilné so SAP aj non-SAP systémami
- check_circle JSON vstup alebo hotový XML — vaša voľba
- check_circle Schematron validácia na požiadanie
- check_circle Sledovanie celého životného cyklu dokladu
- check_circle OpenAPI dokumentácia + Swagger live testing
Štyri funkčné skupiny
API je postavené okolo štyroch jasných oblastí, každá so svojou sadou endpointov — pokrývajú celý tok od autentifikácie až po monitoring stavov.
Autentifikácia
Každá požiadavka musí obsahovať statický HTTP hlavičkový token — X-API-Token. Voliteľné hlavičky umožňujú validáciu XML schémy (X-Validation) alebo testovací režim bez reálneho odoslania (X-TestOnly).
Faktúry
Odošlite faktúru priamo do Peppol siete prostredníctvom AS4. Vstupom môže byť štruktúrovaný JSON — výsledné BIS 3 UBL XML vygenerujeme za vás — alebo hotový XML súbor, ktorý pripravíte sami. Voliteľná Schematron validácia je samozrejmosťou.
Dobropisy a ťarchopisy
Rovnaký prístup platí aj pre opravné doklady. Samostatné endpointy pokrývajú dobropisy aj ťarchopisy, fungujú na rovnakom princípe ako pri odosielaní faktúr.
Stavy dokladov
Sada GET endpointov umožňuje sledovať celý životný cyklus dokumentu: aktuálny stav doručenia, históriu spracovania, frontu čakajúcich dokladov a filtrovanie podľa identifikátora klienta.
Vybrané endpointy
Nižšie uvedený zoznam je reprezentatívna podmnožina. Kompletná referencia je vždy aktuálna v Swagger dokumentácii.
/api/v1/credit-notes/submit Odoslanie BIS 3 dobropisu do siete Peppol.
/api/v1/invoices/files Získanie súborov dokumentu — vráti súbory spojené s daným dokladom.
/api/v1/invoices/submit Odoslanie faktúry do siete Peppol — vráti UUID priradeného záznamu.
/api/v1/invoices/status Audit log dokumentu — vráti históriu spracovania a stavov konkrétneho dokladu.
/api/identity/check Overenie API tokenu — potvrdí platnosť tokenu a dostupnosť API služby.
/api/v1/pdf/tdd/generate Generovanie PDF z TDD XML — vstupom je TDD XML dokument, výstupom hotový PDF súbor.
/api/v1/pdf/mls/generate Generovanie PDF z MLS XML — vstupom je MLS XML dokument, výstupom hotový PDF súbor.
/api/v1/pdf/document/generate Generovanie PDF z UBL XML — vstupom je ľubovoľný UBL XML dokument, výstupom hotový PDF súbor.
Naživo cez Swagger
REST API je kompletne opísané pomocou štandardu OpenAPI a sprístupnené cez Swagger UI. Otvorte ho v akomkoľvek prehliadači a uvidíte každý dostupný endpoint, jeho požadované parametre, schémy požiadaviek a príklady odpovedí.
Priamo cez Swagger si môžete jednotlivé endpointy aj vyskúšať — otestujte volania ešte pred tým, ako začnete programovať.
