mib:Peppol REST API
Propojte jakýkoli fakturační systém se sítí Peppol přes náš certifikovaný Access Point.
Peppol pro jakýkoli systém
Vše, co poskytujeme prostřednictvím našeho Access Pointu, je dostupné i jako REST API — navržené speciálně pro společnosti, které si chtějí Peppol integrovat přímo do vlastního systému. Bez ohledu na to, zda používáte SAP, vlastní ERP nebo zcela jiný fakturační systém, naše API za vás řeší celou komunikaci se sítí Peppol.
API je organizováno do čtyř funkčních skupin: autentizace, odesílání faktur, dobropisy a vrubopisy a sledování stavů dokladů. Každá skupina má jasně definované endpointy, zdokumentované přes OpenAPI a dostupné k přímému testování přes Swagger.
- check_circle Kompatibilní se SAP i non-SAP systémy
- check_circle JSON vstup nebo hotové XML — vaše volba
- check_circle Schematron validace na vyžádání
- check_circle Sledování celého životního cyklu dokladu
- check_circle OpenAPI dokumentace + Swagger live testing
Čtyři funkční skupiny
API je postaveno kolem čtyř jasných oblastí, každá se svou sadou endpointů — pokrývají celý tok od autentizace až po monitoring stavů.
Autentizace
Každý požadavek musí obsahovat statický HTTP hlavičkový token — X-API-Token. Volitelné hlavičky umožňují validaci XML schématu (X-Validation) nebo testovací režim bez reálného odeslání (X-TestOnly).
Faktury
Odešlete fakturu přímo do sítě Peppol prostřednictvím AS4. Vstupem může být strukturovaný JSON — výsledné BIS 3 UBL XML vygenerujeme za vás — nebo hotový XML soubor, který připravíte sami. Volitelná Schematron validace je samozřejmostí.
Dobropisy a vrubopisy
Stejný přístup platí i pro opravné doklady. Samostatné endpointy pokrývají dobropisy i vrubopisy a fungují na stejném principu jako odesílání faktur.
Stavy dokladů
Sada GET endpointů umožňuje sledovat celý životní cyklus dokumentu: aktuální stav doručení, historii zpracování, frontu čekajících dokladů a filtrování podle identifikátoru klienta.
Vybrané endpointy
Níže uvedený seznam je reprezentativní podmnožina. Kompletní reference je vždy aktuální ve Swagger dokumentaci.
/api/v1/credit-notes/submit Odeslání BIS 3 dobropisu do sítě Peppol.
/api/v1/invoices/files Získání souborů dokumentu — vrátí soubory spojené s daným dokladem.
/api/v1/invoices/submit Odeslání faktury do sítě Peppol — vrátí UUID přiřazeného záznamu.
/api/v1/invoices/status Audit log dokumentu — vrátí historii zpracování a stavů konkrétního dokladu.
/api/identity/check Ověření API tokenu — potvrdí platnost tokenu a dostupnost API služby.
/api/v1/pdf/tdd/generate Generování PDF z TDD XML — vstupem je TDD XML dokument, výstupem hotový PDF soubor.
/api/v1/pdf/mls/generate Generování PDF z MLS XML — vstupem je MLS XML dokument, výstupem hotový PDF soubor.
/api/v1/pdf/document/generate Generování PDF z UBL XML — vstupem je libovolný UBL XML dokument, výstupem hotový PDF soubor.
Naživo přes Swagger
REST API je kompletně popsáno pomocí standardu OpenAPI a zpřístupněno přes Swagger UI. Otevřete jej v jakémkoli prohlížeči a uvidíte každý dostupný endpoint, jeho požadované parametry, schémata požadavků a příklady odpovědí.
Přímo přes Swagger si můžete jednotlivé endpointy i vyzkoušet — otestujte volání ještě předtím, než začnete programovat.
