Poštár

Dokumentace API

Vyberte integrační scénář API podle vašeho použití

API podporuje několik integračních modelů. Vyberte si podle typu vašeho produktu a provozních potřeb.

Prostředí: produkce a sandbox

  • Produkce (https://app.peppos.cz) je pouze pro skutečný produkční provoz. Je vyžadováno skutečné ověření zákazníka.
  • Sandbox (https://sandbox.peppos.cz) je pouze pro hraní a testování. Nejde o skutečnou produkci, ale je připojen k testovací síti Peppol, takže můžete doručovat zprávy do dalších testovacích přístupových bodů. Neúčtují se žádné peníze. Ověření můžete přeskočit a odeslat tolik testovacích zpráv, kolik potřebujete.

Jsem developer na míru

Pokud vytváříte aplikaci pro sebe nebo pro jednoho klienta a chcete přijímat nebo odesílat doklady, použijte API klíč s přístupem k jednomu participantovi (firmě).

Použijte autorizační endpoint pro převod client_id/client_secret na Bearer token /api/auth/token (více informací).

Použijte zjednodušené endpointy pro odesílání:

/api/documents/send?wait-for-result nebo /api/documents/send/isdoc?wait-for-result

Související odkazy: Dokumentace | Příklad

Jsem účetní kancelář

Použijte API klíč s přístupem ke všem participantům (firmám) a odesílejte doklady přes participant-scoped routy.

Použijte autorizační endpoint pro převod client_id/client_secret na Bearer token /api/auth/token (více informací).

Endpointy pro odesílání:

/api/participants/{PARTICIPANT_ID}/documents/send?wait-for-result nebo /api/participants/{PARTICIPANT_ID}/documents/send/as/isdoc?wait-for-result

PARTICIPANT_ID může být:

  • ext:VÁŠ_IDENTIFIKÁTOR
  • Peppol ID (například 9929:12345678)
  • UUID přidělené naší platformou

Související odkazy: Dokumentace | Příklad

Jsem developer a autor SaaS

Typický flow je nabídnout v aplikaci "Odesílejte faktury do Peppol", přesměrovat uživatele na OAuth souhlas a potom používat vydaný refresh token pro odesílání nebo příjem dokladů jménem uživatele.

Pokračujte tím, že v sekci Developers přidáte aplikaci a nastavíte požadovaná oprávnění.

Pak stačí používat zjednodušené endpointy pro odesílání:

/api/documents/send?wait-for-result nebo /api/documents/send/isdoc?wait-for-result

Související odkazy: Dokumentace | Příklad | Vývojáři

Jsem developer a autor SaaS se specializací na faktury

Pro účetní, fakturační nebo vytěžovací systémy je onboarding často jednodušší, když klient nemusí nejprve ručně vytvořit účet a pak se vracet zpět pro udělení přístupu.

Účty klientů můžete zakládat automaticky a verifikaci spouštět přímo z aplikace. Běžné varianty jsou:

  • Každého klienta už znáte a verifikaci (KYC) zajišťujete vlastním smluvním procesem.
  • Účet založíte vy a verifikaci dokončí Dativery (například přes Bank iD a další metody).

Na Slovensku je potřeba během verifikačního flow potvrdit příjem na portálu finanční správy.

V tomto modelu si vytvoříte API klíč, založíte jednotlivé klienty a následně odesíláte doklady pod jejich participanty.

Související odkazy: Dokumentace | Příklad | Nejjednodušší příklad

Pracuji s jednoduchou aplikací bez backendu

Využijte komponentu tlačítka "Odeslat přes Peppol". Umožní vám zajistit odeslání i bez vlastního backendu; uživatel bude během flow vyzván k přihlášení.

Související odkazy: Dokumentace | Příklad