
Ať už jste malá firma, velký podnik nebo dodavatel softwaru, API společnosti Qvalia vám nabízí jednotný, standardizovaný způsob integrace do sítě Peppol s volitelnou podporou dalších EDI toků, inteligentního zpracování dokumentů a obohacování dat.
Prostřednictvím služby Invoicing API můžete pracovat s fakturačními zprávami Peppol, jako jsou BIS Billing faktura), BIS Billing Note (dobropis), BIS Self-Billing Invoice (faktura s vlastním vyúčtováním), BIS Self-Billing Credit Note (dobropis s vlastním vyúčtováním) a BIS Invoice Response(odpověď na fakturu), a v případě potřeby je doplnit o Message Level Response (odpověď na úrovni zprávy) pro technická potvrzení související s fakturami a dalšími zprávami Peppol.
API může:
- Pomozte malé společnosti rychle začít odesílat faktury Peppol
- Podpora velkých podniků se strukturovanými toky zpráv s velkým objemem
- Software pro fakturaci energie a ERP systémy, které vyžadují připojení více uživatelů pro mnoho zákazníků
V tomto průvodci se naučíte:
- Nastavte transakční API Qvalia jako svůj hub Peppol a EDI
- Vyměňte svou první fakturu Peppol prostřednictvím API
- Rozšiřte své možnosti nad rámec faktur na objednávky, katalogy a další dokumenty.
- Umožňuje škálovatelné modely pro více uživatelů pro dodavatele softwaru
- Přidejte pokročilé funkce založené na umělé inteligenci pro obohacení dat a extrakci PDF.
Přehled: API pro Peppol a EDI
Peppol API poskytuje jednotné rozhraní pro elektronické obchodní zprávy přes Peppol a EDI. Je navrženo tak, aby podporovalo základní scénáře, jako například:
- Faktury a dobropisy
- Objednávky a odpovědi na objednávky
- Změny a zrušení objednávek
- Katalogy a aktualizace položek
- Oznámení o odeslání
- Odpovědi na úrovni zpráv a aktualizace stavu
Ve všech koncových bodech se používá společný princip návrhu:
- HTTP koncové body založené na REST
- Podpora formátů JSON i XML
- UBL 2.1 jako základní datový model
- Zpracování chyb pomocí standardních stavových kódů HTTP
Pro vás to znamená, že můžete uvažovat v termínech obchodních zpráv namísto sítí a protokolů. Vytváříte platné dokumenty založené na UBL; Qvalia zpracovává vrstvu Peppol a EDI na pozadí.
Začínáme: předpoklady a nastavení
Začátek práce s Peppol API od společnosti Qvalia vyžaduje pouze několik základních kroků:
Účet Qvalia
Vaše organizace je zaregistrována jako zákazník Qvalia. Obdržíte registrační číslo účtu, které jednoznačně identifikuje váš účet ve všech transakčních hovorech.
API klíč
Ověřování se provádí pomocí API klíče, přičemž pro testovací a produkční prostředí se používají samostatné klíče. Všechna volání se provádějí přes HTTPS s moderním TLS.
Číslo registrace účtu v cestě URL
Transakční volání obsahují vaše číslo účtu (accountRegNo) v cestě. Například:
POST /transaction/{accountRegNo}/invoices/outgoing
Volba formátu: JSON nebo XML
Formát JSON nebo XML můžete vybrat pomocí standardních hlaviček HTTP (Content-Type a Accept). Pokud není výslovně zvolen žádný formát, je výchozím formátem JSON.
Jakmile budou tyto prvky připraveny, můžete začít testovat provoz Peppol s Qvalia.
Krok za krokem: integrace vašeho prvního toku faktur Peppol (odesílání a přijímání)
Tato část popisuje typickou první integraci mezi vaším systémem a transakčním API společnosti Qvalia a zahrnuje jak odesílání, tak přijímání faktur Peppol.
Krok 1: Začněte v pískovišti
Začněte integrací do prostředí sandboxu:
- Základní URL (příklad): https://api-qa.qvalia.com
- Stejný model ověřování, koncové body a struktura jako v produkčním prostředí
To vám umožňuje vytvářet a testovat bez ovlivnění skutečných zákazníků nebo finančních toků.
Krok 2: Použijte svůj API klíč a číslo účtu (accountRegNo)
Ve vaší konfiguraci uložte:
- Váš API klíč (pro sandbox)
- Vaše číslo účtuRegNo
Každá žádost by měla obsahovat:
- Autorizační záhlaví s klíčem API
- accountRegNo v cestě koncového bodu, například:
Odeslané faktury:/transaction/{accountRegNo}/invoices/outgoing
Příchozí faktury (pull):/transaction/{accountRegNo}/invoices/incoming
Krok 3: Vyberte JSON nebo XML (na základě UBL)
Všechny transakce používají jako základní standard UBL 2.1.
Můžete buď:
- Generovat UBL 2.1 XML, nebo
- Použijte reprezentaci UBL JSON a namapujte stejnou strukturu do polí JSON.
Formát řídí hlavičky:
JSON (výchozí)
Content-Type: application/jsonAccept: application/json
XML
Content-Type: application/xmlAccept: application/xml
Tato flexibilita vám umožňuje integrovat rozhraní API Peppol do prostředí JSON-first i XML-first.
Krok 4: Přiřaďte svou fakturu k UBL
Dále namapujte svůj interní model faktury na prvky UBL. K dispozici jsou formáty UBL JSON i UBL XML.
- Informace v záhlaví (faktura, datum vystavení, kód typu faktury)
- Strany (Účetní dodavatel, Účetní zákazník)
- Celkové částky (Daňová celková částka, Právní peněžní celková částka)
- Řádky (InvoiceLine, Item, Price, TaxCategory)
Cílem je zajistit, aby:
- Všechna povinná pole jsou vyplněna.
- Hodnoty odpovídají příslušnému profilu Peppol (například BIS Billing)
- Jsou splněny vaše vlastní obchodní požadavky (reference, nákladová střediska, kódy projektů)
Poté to serializujete jako JSON nebo XML, v závislosti na zvoleném formátu. U příchozích faktur použijete stejnou strukturu UBL při čtení, ověřování a mapování dat z Qvalia do vašeho interního modelu.
Krok 5a: Odeslání odchozí faktury Peppol
Krok 5.1: Odeslání odchozí faktury Peppol
S připraveným odchozím datovým obsahem, příklad koncového bodu:
POST https://api-qa.qvalia.com/transaction/{accountRegNo}/invoices/outgoing
Zahrnout:
- Autorizační záhlaví s vaším klíčem API
- Správná hlavička Content-Type (JSON nebo XML)
- Náplň faktury založená na UBL v těle požadavku
Qvalia ověří fakturu, odešle ji prostřednictvím sítě Peppol neboVAN a vrátí odpověď s identifikátory a stavem.
Krok 5.2: Příjem příchozích faktur Peppol
Chcete-li načíst příchozí faktury z Qvalia prostřednictvím API, obvykle:
Zavolejte příchozí koncový bod, například:
GET https://api-qa.qvalia.com/transaction/{accountRegNo}/invoices/incoming
Volitelně můžete:
- Filtrujte nebo stránkujte výsledky (v závislosti na vašem nastavení)
- Použijte koncové body „read“ k rozlišení nových a již zpracovaných faktur.
Vrácený UBL JSON nebo XML je poté namapován do vašeho interního datového modelu pro zveřejnění, schválení nebo další zpracování.
Krok 6: Zpracování monitorování, odpovědí a chyb
Transakční API používá předvídatelné stavové kódy HTTP, které můžete přiřadit k protokolům, monitorování a zprávám uživatelů. Typické vzorce:
- 200 OK – Požadavek byl úspěšný a data byla vrácena.
- 204 Žádný obsah – Žádost byla úspěšná, ale není k dispozici žádné tělo.
- 400 / 422 – Neplatná data nebo schéma; upravte své užitečné zatížení nebo analýzu
- 401 / 403 – Problémy s ověřením nebo oprávněním
- 404 – Zdroj nebyl nalezen (často se jedná o problém s cestou nebo ID)
- 409 – Konflikt, například duplicity
- 429 – Dosáhli jste limitu rychlosti; zpomalte své požadavky
- 500 – Interní chyba; zkuste to znovu nebo informujte podporu, pokud chyba přetrvává
Stejné postupy platí jak pro odesílání, tak pro přijímání faktur.
Použijte protokol transakcí pro operativní sledování
Kromě odpovědí API se můžete kdykoli přihlásit do Qvalia a zkontrolovat aktivitu v protokolu transakcí. Získáte tak přehled o tom, co se děje ve vaší integraci, včetně například:
- Odeslané a přijaté faktury
- Stav jednotlivých transakcí
- Podrobnosti o chybě a zpětná vazba k ověření
- Technické a obchodní časové značky
Transakční protokol je užitečný pro:
- Týmy první linie podpory a provozní týmy, které nepracují přímo s API
- Řešení konkrétních problémů nahlášených zákazníky nebo interními uživateli
- Ověření, že změny ve vaší integraci fungují v produkčním prostředí podle očekávání
HTTP stavové kódy a protokol transakcí společně poskytují ucelený obraz: váš systém může programově reagovat na odpovědi, zatímco váš tým může v případě potřeby provádět vyšetřování a sledování přímo v Qvalia.
Více než jen faktury: rozšířte možnosti využití Peppol API
Jakmile budete mít faktury připravené, je snadné rozšířit integraci na kompletní portfolio zpráv Peppol.
Mezi typická rozšíření patří:
Objednávky. Elektronické přijímání a odesílání strukturovaných objednávek
Odpovědi na objednávky a změny. Potvrzení, změna nebo zrušení objednávek
Katalogy. Správa informací o produktech a cenách v elektronických katalozích
Oznámení o odeslání. Sdělování informací o zásilkách
Odpovědi na úrovni zpráv. Sledování potvrzení na technické a obchodní úrovni
Vzhledem k tomu, že vše využívá stejný design API, model ověřování a datový model UBL 2.1, nepotřebujete pro každý typ dokumentu samostatné projekty nebo brány. Nové případy použití můžete aktivovat podle toho, jak se vyvíjí vaše podnikání nebo požadavky vašich zákazníků.
Právě zde se slib „jedno API Peppol bez ohledu na potřeby“ stává hmatatelným: stejná integrace slouží malým dodavatelům, velkým podnikům i komplexním scénářům platforem.
Partnerské API pro fakturační software a ERP systémy
Pokud jste dodavatelem softwaru – provozujete fakturační platformu, ERP, účetní řešení nebo integrační platformu – vaše požadavky se mírně liší. S Partner API od Qvalia můžete nastavit konfiguraci pro více uživatelů pro výměnu zpráv pro koncové uživatele, včetně správy Peppol ID .
Partner API pro Peppol je nutné, pokud potřebujete:
- Obsluhujte mnoho koncových zákazníků z jedné platformy
- Zajistěte jasné oddělení údajů a transakcí jednotlivých zákazníků.
- Vyhněte se provozování vlastního přístupového bodu Peppol nebo brány EDI.
Model společnosti Qvalia zaměřený na partnerství je navržen speciálně pro tento účel.
Jak funguje nastavení partnera
- Vaše společnost je zaregistrována jako partner a obdrží identifikační číslo partnera.
- Můžete si vybrat mezi dvěma způsoby zpracování zpráv koncových uživatelů: 1) konsolidovaný sdílený uživatelský účet nebo 2) individuální účty Qvalia pro každého koncového uživatele, každý s vlastním číslem účtu (accountRegNo).
- Volání API zahrnují jak kontext vašeho partnera, tak konkrétní zákaznický účet, což vám umožňuje odesílat a přijímat zprávy jejich jménem.
Příklad: Implementace partnera
Zaškolení
- Vaše organizace obdrží partnerské přihlašovací údaje a konfiguraci, včetně partnerRegNo a API klíče.
- Nastavíte jedinou integraci směrem k API Qvalia pomocí
/partner/{partnerRegNo}předpona pro všechny volání v rámci partnerství.
Začlenění zákazníků do vašeho produktu
- Když zákazník aktivuje Peppol/elektronickou fakturaci ve vašem uživatelském rozhraní, je pro něj vytvořen nebo propojen účet Qvalia.
- Účetní číslo zákazníka (accountRegNo) ukládáte společně s vlastním zákaznickým ID, abyste mohli zpracovávat transakce podle jednotlivých zákazníků.
Odesílání a přijímání transakcí podle zákazníka
Vaše aplikace generuje nebo spotřebovává užitečná data UBL (faktury, objednávky atd.) stejným způsobem jako standardní rozhraní API transakcí. Chcete-li odesílat nebo přijímat transakce jménem konkrétního zákazníka, vyvoláte rozhraní API transakcí prostřednictvím vzoru URI s předponou partnera:
/partner/{partnerRegNo}/transaction/{accountRegNo}/{message-type}/{direction}
Například:
- Odeslání vystavené faktury:
/partner/{partnerRegNo}/transaction/{accountRegNo}/invoices/outgoing(POST) - Načítání příchozích faktur:
/partner/{partnerRegNo}/transaction/{accountRegNo}/invoices/incoming(ZÍSKAT) - Použití
readvarianty, kde je to vhodné, přidánímreadna cestě.
Qvalia směruje a přijímá zprávy, jako by byly odeslány nebo přijaty přímo zákazníkem, s plnou sledovatelností podle účtu.
Výhody pro prodejce softwaru
- Jedna technická integrace, mnoho zákazníků, využívající konzistentní model partnerství a účtů.
- Není třeba provozovat a udržovat vlastní páteřní síť Peppol nebo EDI.
- Snadné rozšíření na nové trhy, mandáty a typy zpráv díky opětovnému použití stejného modelu integrace partnerů.
Další funkce: obohacení o AI agenty
Kromě přepravy a konektivity nabízí Qvalia také rozšiřující API, které může obohatit transakce o klasifikaci položek, zpracování před a po transakci a další funkce a které dokáže s minimálním úsilím extrahovat a transformovat dokumenty PDF na bohatá, strukturovaná a ověřená data.
Rozšiřující API je navrženo jako asynchronní služba:
- Prostřednictvím API odešlete soubor s fakturou (např. PDF nebo XML).
- V odpovědi obdržíte pollingId.
- Vy provádíte dotazování stavu, dokud není obohacení dokončeno.
- Získáte strukturovaný výsledek JSON s obohacenými informacemi.
Tento výsledek může zahrnovat:
- Analyzovaný obsah faktury extrahovaný z původního souboru
- Validace podle Peppol nebo jiných obchodních pravidel
- Normalizovaná pole vhodná pro analytiku, automatizaci a pracovní postupy umělé inteligence
Vzor implementace
Typická integrace vypadá takto:
Odeslat fakturu za obohacení
Zavolejte koncový bod, připojte soubor s fakturou a veškerá relevantní metadata a
Uložte vrácené pollingId.
POST /enrichment/{accountRegNo}/invoice
Dotaz na dokončení
Volání v bezpečných intervalech. Během zpracování API potvrzuje, že úloha stále běží. Po dokončení vrátí stav a odkaz na výsledek obohacení.
GET /enrichment/{accountRegNo}/{pollingId}
Načtení konkrétních typů obohacení
Volání pro získání konkrétního výstupu obohacení – například podrobných údajů o fakturách nebo výsledků ověření Peppol. Tyto údaje můžete vložit do svého účetního systému, analytického stacku nebo automatizační logiky.
GET /enrichment/{accountRegNo}/{pollingId}/{enrichmentType}
Případy použití
- Malé podniky
mohou těžit z inteligentního zpracování dokumentů na podnikové úrovni; čistá, strukturovaná data bez nutnosti investic do složitých nástrojů OCR nebo ověřování. - Large
Mohou standardizovat údaje na fakturách a dokumentech napříč entitami, systémy a geografickými oblastmi a umožnit lepší kontrolu dat, analytiku a automatizaci účetnictví. - Prodejci softwaru a partneři
Mohou přímo do svých produktů zabudovat pokročilé funkce obohacování, aniž by museli vytvářet vlastní parsovací a pravidlové moduly.
Ve všech případech je přístup k této technologii velmi jednoduchý: stejný účet a bezpečnostní model jako u Transaction API a malá sada dobře definovaných koncových bodů.
Přístup k API Peppol pro jakoukoli firmu
API společnosti Qvalia je navrženo tak, aby vám poskytlo zjednodušený a škálovatelný přístup k síti Peppol, bez ohledu na typ vaší společnosti:
- Malá firma, která potřebuje vyměňovat elektronické faktury v souladu s předpisy
- Velký podnik spravující velké objemy toků mezi více subjekty
- Dodavatel softwaru nabízející fakturační, ERP nebo finanční řešení pro mnoho zákazníků
Další krok je jednoduchý: připojte se k testovacímu prostředí, odešlete svou první zkušební fakturu a začněte plánovat, jak se Peppol, EDI a obohacení mohou stát nedílnou součástí vašich operací nebo produktu – namísto samostatného, komplexního projektu.
