Nech ste malá firma, veľký podnik alebo dodávateľ softvéru, rozhranie API spoločnosti Qvalia vám ponúka jediný štandardizovaný spôsob integrácie so sieťou Peppol s voliteľnou podporou ďalších tokov EDI, inteligentného spracovania dokumentov a obohacovania údajov.

Through the service Invoicing API, you can work with invoice-related Peppol messages such as BIS Billing (invoice), BIS Billing Credit Note (credit note), BIS Self-Billing Invoice, BIS Self-Billing Credit Note and BIS Invoice Response, and, when needed, complement them with Message Level Response for message-level validation results during the MLR transition period. Transport receipts, Message Level Status (MLS) between service providers, and business-level responses are separate mechanisms.

API môže:

V tejto príručke sa naučíte:

Peppol API poskytuje jednotné rozhranie pre elektronické obchodné správy prostredníctvom Peppol a EDI. Je navrhnuté tak, aby podporovalo základné scenáre, ako napríklad:

Všetky koncové body používajú spoločný dizajnový princíp:

Pre vás to znamená, že môžete uvažovať v kategóriách obchodných správ namiesto sietí a protokolov. Vytvárate platné dokumenty založené na UBL; Qvalia spracováva vrstvu Peppol a EDI na pozadí.

Na začatie práce s rozhraním Peppol API spoločnosti Qvalia potrebujete len niekoľko základných informácií:

Účet Qvalia
Vaša organizácia je zaregistrovaná ako zákazník Qvalia. Dostanete registračné číslo účtu, ktoré jednoznačne identifikuje váš účet vo všetkých transakčných volaniach.

Kľúč API
Overovanie sa vykonáva prostredníctvom kľúča API, pričom pre testovacie a produkčné prostredia sa používajú samostatné kľúče. Všetky volania sa vykonávajú cez HTTPS s moderným TLS.

Číslo registrácie účtu v ceste URL
Transakčné volania obsahujú vaše číslo registrácie účtu (accountRegNo) v ceste. Napríklad:

Voľba formátu: JSON alebo XML
Môžete si vybrať JSON alebo XML prostredníctvom štandardných HTTP hlavičiek (Content-Type a Accept). Ak nie je explicitne zvolený žiadny formát, predvoleným formátom je JSON.

Akonáhle sú tieto prvky na mieste, ste pripravení začať testovať prevádzku Peppol s Qvalia.

Táto časť vás prevedie typickou prvou integráciou medzi vaším systémom a transakčným API Qvalia, ktorá zahŕňa odosielanie aj prijímanie faktúr Peppol.

Začnite integráciou do prostredia sandboxu:

To vám umožňuje vytvárať a testovať bez ovplyvnenia skutočných zákazníkov alebo finančných tokov.

V konfigurácii uložte:

Každá žiadosť by mala obsahovať:

Peppol business document endpoints use the UBL 2.1-based structure defined by the applicable BIS or PINT specification. Other Qvalia APIs and endpoints may use different payload models; confirm the current API documentation for the endpoint you are implementing.

Môžete buď:

Formát riadia hlavičky:

JSON (predvolené)

XML

Táto flexibilita vám umožňuje integrovať rozhranie Peppol API do prostredí JSON-first aj XML-first.

Ďalej priraďte svoj interný model faktúry k prvkom UBL. K dispozícii sú formáty UBL JSON aj UBL XML.

Cieľom je zabezpečiť, aby:

Potom to serializujete ako JSON alebo XML, v závislosti od vášho výberu formátu. Pre prichádzajúce faktúry použijete rovnakú štruktúru UBL pri čítaní, overovaní a mapovaní údajov z Qvalia do vášho interného modelu.

Step 5: Send an outgoing Peppol invoice

S pripraveným odchádzajúcim dátovým nákladom, príklad koncového bodu:

Zahrnúť:

Qvalia overí faktúru, odošle ju prostredníctvom siete Peppol aleboVAN a vráti odpoveď s identifikátormi a stavom.

Na načítanie prichádzajúcich faktúr z Qvalia prostredníctvom API zvyčajne:

Zavolajte prichádzajúci koncový bod, napríklad:

Voliteľne môžete:

Vrátený UBL JSON alebo XML sa potom zmapuje do vášho interného dátového modelu na účely zverejnenia, schválenia alebo ďalšieho spracovania.

Transakčné API používa predvídateľné kódy stavu HTTP, ktoré môžete priradiť k protokolom, monitorovaniu a správam používateľov. Typické vzory:

The same patterns apply whether you are sending or receiving invoices. OpenPeppol is replacing MLR with MLS in the eDelivery layer: the MLS activation window starts on 1 March 2027, MLS becomes mandatory for service providers on 1 April 2027, and MLR is retired on 1 May 2027.

Okrem odpovedí API sa môžete kedykoľvek prihlásiť do Qvalia a skontrolovať aktivitu v protokole transakcií. Tým získate prehľad o tom, čo sa deje vo vašej integrácii, vrátane napríklad:

Protokol transakcií je užitočný pre:

HTTP stavové kódy a protokol transakcií spoločne poskytujú ucelený obraz: váš systém môže programovo reagovať na odpovede, zatiaľ čo váš tím môže v prípade potreby priamo v Qvalia vyšetrovať a sledovať situáciu.

Akonáhle máte faktúry na mieste, je jednoduché rozšíriť integráciu na kompletné portfólio správ Peppol.

Typical extensions include:
Orders. Receive and send structured orders electronically
Order responses and changes. Confirm, modify, or cancel orders
Catalogues. Maintain product and price information in electronic catalogues
Despatch advice. Communicate shipment information
Message-level validation and status. Track MLR during the transition period, MLS between service providers, and the relevant business response for each process

The available endpoints use a consistent account and authentication model, but payload structures and enabled message types depend on the relevant Peppol profile and your Qvalia service configuration. You enable new use cases as your business or your customers’ requirements evolve.

Tu sa stáva hmatateľným sľub „jedno rozhranie Peppol API bez ohľadu na potreby“: tá istá integrácia slúži malým dodávateľom, veľkým podnikom aj komplexným platformovým scenárom.

Ak ste dodávateľom softvéru – prevádzkujete fakturačnú platformu, ERP, účtovné riešenie alebo integračnú platformu – vaše požiadavky sú trochu odlišné. S Partner API od Qvalia môžete nastaviť konfiguráciu pre viacerých používateľov na výmenu správ pre koncových používateľov, vrátane správy Peppol ID .

Partner API pre Peppol je potrebné, ak potrebujete:

Model spoločnosti Qvalia zameraný na partnerstvo je navrhnutý špeciálne na tento účel.

Vaša aplikácia generuje alebo spotrebováva dáta UBL (faktúry, objednávky atď.) rovnakým spôsobom ako štandardné rozhranie API transakcií. Ak chcete odosielať alebo prijímať transakcie v mene konkrétneho zákazníka, voláte rozhranie API transakcií prostredníctvom vzoru URI s predponou partnera:

Napríklad:

Qvalia smeruje a prijíma správy tak, ako keby boli odoslané alebo prijaté priamo zákazníkom, s úplnou sledovateľnosťou podľa účtu.

Okrem dopravy a konektivity ponúka Qvalia aj rozširujúce rozhranie API, ktoré môže obohatiť transakcie o klasifikáciu položiek, spracovanie pred a po transakcii a ďalšie funkcie a ktoré dokáže s minimálnym úsilím extrahovať a transformovať dokumenty PDF na bohaté, štruktúrované a overené údaje.

Rozširujúce API je navrhnuté ako asynchrónna služba:

Tento výsledok môže zahŕňať:

Typická integrácia vyzerá takto:

Odošlite faktúru za obohatenie
Vyvolajte koncový bod, priložte súbor s faktúrou a všetky relevantné metadáta a
Uložte vrátené pollingId.

Prieskum o dokončení
Volajte v bezpečných intervaloch. Počas spracovania API potvrdzuje, že úloha stále beží. Po dokončení vráti stav a odkazy na výsledok obohatenia.

Načítanie konkrétnych typov obohatenia
Vyvolajte na získanie konkrétneho výstupu obohatenia – napríklad podrobné údaje o faktúrach alebo výsledky validácie Peppol. Vložte to do svojho účtovného systému, analytického stacku alebo automatizačnej logiky.

Vo všetkých prípadoch je prístup k tejto technológii jednoduchý: rovnaký účet a bezpečnostný model ako v prípade rozhrania API pre transakcie a malá sada jasne definovaných koncových bodov.

API spoločnosti Qvalia je navrhnuté tak, aby vám poskytlo zjednodušený a škálovateľný prístup k sieti Peppol, bez ohľadu na typ vašej spoločnosti:

Ďalší krok je jednoduchý: pripojte sa k sandboxu, odošlite svoju prvú testovaciu faktúru a začnite plánovať, ako sa Peppol, EDI a obohatenie môžu stať integrálnou súčasťou vašich operácií alebo produktu – namiesto samostatného, komplexného projektu.