API Peppol v kostce
Od API klíče k prvnímu požadavku
Náš tým pro zaškolení vám poskytne podporu během integrace a testování.
export ACCOUNT_REG_NO=YOUR_ACCOUNT_REGISTRATION_NUMBER
# Identifies the account in every Transaction API requestTuto hodnotu použijte v adrese požadavku při každém volání rozhraní Transaction API.
export QVALIA_API_KEY=YOUR_SANDBOX_API_KEY
export QVALIA_BASE_URL=https://api-test.qvalia.comUdržujte přihlašovací údaje pro testovací prostředí a produkční prostředí oddělené.
curl -X POST \
${QVALIA_BASE_URL}/transaction/${ACCOUNT_REG_NO}/invoices/outgoing \
-H Authorization:${QVALIA_API_KEY} \
-H Content-Type:application/json \
-d @invoice.jsonTato odpověď potvrzuje, že dokument byl přijat. Výsledky ověření a stav doručení budou následovat prostřednictvím webhooků nebo prostřednictvím stavu dokumentu.
export QVALIA_API_KEY=YOUR_PRODUCTION_API_KEY
export QVALIA_BASE_URL=https://api.qvalia.comSledujte zpracování a doručení prostřednictvím webhooků nebo stavu dokumentu.
Jeden účet, šest API
API pro fakturaci
Odesílejte a přijímejte faktury a dobropisy prostřednictvím Peppolu, s ověřením před doručením.
Objednávka API
Odesílejte a přijímejte objednávky prostřednictvím Peppolu, včetně odpovědí na objednávky, změn a zrušení, a to v rámci celého procesu objednávání.
Partnerské API
Vytvářejte a spravujte účty koncových zákazníků a identifikátory Peppol přímo z vaší vlastní platformy, a to pomocí webhooků pro události související s dokumenty.
OCR API
Extrahujte strukturovaná data z faktur ve formátu PDF za účelem kontroly a dalšího zpracování.
Rozšiřující API
Klasifikujte dokumenty a jednotlivé položky a obohacujte transakce o strukturovaná data.
Účetní API
Vytvářejte návrhy na zaúčtování na základě příchozích faktur, což urychlí jejich kontrolu a zaúčtování.
Další možnosti připojení
Pokud integrace prostřednictvím API není vhodným řešením nebo pokud potřebujete více než jen výměnu dokumentů.
- SFTP
Vyměňujte soubory ve formátu XML nebo CSV přes SFTP, pokud není možná integrace prostřednictvím API. - ERP konektory
Hotové konektory pro běžné ERP a účetní systémy. - Server Peppol MCP
Poskytuje agentům AI a klientům MCP strukturovaný přístup k transakcím, položkám, stavu dodání a ověření. - Punchout
Propojte katalog dodavatele s nákupním systémem odběratele. - B2B pokladna
Přidejte do obchodu WooCommerce možnost platby a fakturace B2B s doručením přes Peppol.
Referenční příručka Peppol pro vývojáře
Tato stránka se zabývá rozhraními API společnosti Qvalia a dokumenty formátu Peppol, které přenášejí. Standard Peppol, na kterém jsou založeny, včetně specifikací, pravidel validace a seznamů kódů, je popsán v naší dokumentaci k Peppolu a v příručce k implementaci. Kompletní přehled koncových bodů najdete na adrese api.qvalia.io. Normativní specifikace Peppolu zveřejňuje organizace OpenPeppol na stránkách docs.peppol.eu.
Dokumenty Peppol a jejich rozhraní API
| Dokument | Specifikace Peppol | Rozhraní API Qvalia |
| Faktura | Peppol BIS Billing .0 | Rozhraní API pro faktury |
| Dobropis | Peppol BIS Billing 3.0, dobropis | API pro dobropisy |
| Objednávka a potvrzení objednávky | BIS Ordering Peppol BIS Ordering | API pro objednávky, API pro odpovědi na objednávky |
| Objednávková smlouva | BIS Order Agreement Peppol BIS Order Agreement | Objednání rozhraní API pro smlouvy |
| Změna a zrušení objednávky | Peppol BIS Advanced Ordering | API pro změnu objednávky, API pro zrušení objednávky |
| Oznámení o odeslání | Peppol BIS Despatch Advice | API pro oznámení o odeslání |
| Katalog | Peppol BIS Catalogue s odpovědí | Rozhraní API katalogů |
| Stav dodávky | Reakce na úrovni zprávy a stav na úrovni zprávy | Rozhraní API pro odezvy na úrovni zpráv, rozhraní API pro stav na úrovni zpráv |
Ověření a chyby
Seznamy kódů
Adresování a vyhledávání
Testování a provoz
Pískoviště
Otestujte si integraci s vašimi vlastními systémy, aniž byste tím ovlivnili skutečné zákazníky nebo finanční toky.
Verzování
Zásadní změny se vydávají jako nová verze API, a to s minimálně měsíčním předběžným oznámením.
Stav systému
Zobrazit aktuální dostupnost služeb a nejnovější informace o poruchách.
Bezpečnost
Přečtěte si, jak společnost Qvalia přistupuje k informační bezpečnosti, zajištění nepřetržitého chodu podniku a budování důvěry.
Peppol pro vaši firmu nebo pro vaše zákazníky?
Přístupový bod Peppol
Chcete odesílat a přijímat dokumenty Peppol pro svou firmu. Připojte se k přístupovému bodu Peppol společnosti Qvalia a integrujte jej do svého ERP systému nebo prostřednictvím API.
Řešení partnerů
Nabídněte službu Peppol svým zákazníkům v rámci modelu, který nejlépe odpovídá vaší roli. Integrujte službu Peppol do svého produktu prostřednictvím API společnosti Qvalia, nebo provozujte hostovaný přístupový bod pod svou vlastní identitou poskytovatele služeb Peppol.
Otázky, které si kladou vývojáři
Další pokyny k implementaci najdete v naší znalostní databázi.
Existuje nějaké testovací prostředí?
Ano. Testovací prostředí na adrese api-test.qvalia.com využívá samostatný klíč API, takže můžete provádět testy, aniž by to mělo dopad na skutečné zákazníky nebo finanční toky. Postupujte podle podrobného návodu k API Peppol v sekci Znalostní báze.
Jaké formáty API podporuje?
Ve výchozím nastavení JSON nebo XML. Oba formáty využívají struktury založené na standardu UBL 2.1 pro příslušné koncové body dokumentů Peppol. Nastavte hlavičky Content-Type a Accept na hodnotu application/json nebo application/xml. Informace o typech zpráv Peppol pro obchodní dokumenty a procesy podporované sítí naleznete zde.
Jak se mám přihlásit?
Pomocí klíče API v hlavičce Authorization nebo pomocí dočasného tokenu (JWT), který získáte z koncového bodu /token pomocí svého klíče. Pro testovací a produkční prostředí získáte samostatné klíče.
Jak zjistím, zda byl dokument doručen?
Přihlaste se k odběru webhooků nebo provádějte dotazy na API. Qvalia odesílá události při přijetí dokumentu, při jeho doručení a v případě neúspěšného doručení. Informace o odpověďových zprávách na úrovni Peppol najdete v článku „Stav na úrovni zprávy “ v znalostní bázi.
Musím si implementaci přenosu Peppol zajistit sám?
Ne. Společnost Qvalia provozuje přístupový bod a zajišťuje vyhledávání příjemců, přenos přes AS4 i doručení. Dokument odešlete do API. Přečtěte si, jak služby SMP a SML pro vyhledávání služeb lokalizují přijímající koncový bod.
Mohu provést integraci, aniž bych musel psát kód?
Ano. Použijte ERP konektor nebo si vyměňujte soubory ve formátu XML či CSV přes SFTP.
Jaké dokumenty ve formátu Peppol mohu vyměňovat?
Faktury, dobropisy, objednávky, odpovědi na objednávky, dohody k objednávkám, změny a zrušení objednávek, avíza o odeslání, katalogy a odpovědi na úrovni zpráv. Tabulka v části „Referenční údaje Peppol pro vývojáře“ uvádí specifikaci každého z těchto dokumentů. To, které typy dokumentů vaše nastavení zahrnuje, závisí na vybrané službě a integraci. Přehled najdete v článku „Jaké jsou typy zpráv v systému Peppol? “.
Jak API vyhledá koncový bod příjemce?
Qvalia využívá adresu Peppol ID příjemce k vyhledání svého vydavatele metadat služby (SMP) prostřednictvím lokátoru metadat služby (SML). SMP vrátí informace o možnostech dokumentu, procesu a transportním koncovém bodu potřebné pro doručení. Přečtěte si článek „Peppol SMP a SML: jak funguje vyhledávání služeb“.
Co se stane, když dokument neprojde validací Peppol?
Dokument s fatální chybou při ověřování je nutné před odesláním opravit. Kód chyby identifikuje sadu pravidel a část dokumentu, kterou je třeba prověřit. Viz články „Jak funguje ověřování Peppol “ a „Kódy pravidel ověřování Peppol“.
Jak mohu ověřit, zda má příjemce oprávnění k práci s dokumenty ( Peppol ID ) a zda je schopen s dokumenty pracovat?
Pomocí vyhledávání „Peppol ID “ v systému Qvalia vyhledejte účastníka a funkce dokumentů zveřejněné v adresáři. Informace o struktuře a schématech identifikátorů najdete v článku „Co je to Peppol ID? “ v znalostní bázi.