Prehľad rozhrania API Peppol
Od API kľúča po prvú požiadavku
Náš tím zodpovedný za zaškolenie vám poskytuje podporu počas integrácie a testovania.
export ACCOUNT_REG_NO=YOUR_ACCOUNT_REGISTRATION_NUMBER
# Identifies the account in every Transaction API requestTúto hodnotu použite v ceste požiadavky pri každom volaní rozhrania Transaction API.
export QVALIA_API_KEY=YOUR_SANDBOX_API_KEY
export QVALIA_BASE_URL=https://api-test.qvalia.comPrístupové údaje pre testovacie prostredie a produkčné prostredie uchovávajte oddelene.
curl -X POST \
${QVALIA_BASE_URL}/transaction/${ACCOUNT_REG_NO}/invoices/outgoing \
-H Authorization:${QVALIA_API_KEY} \
-H Content-Type:application/json \
-d @invoice.jsonTáto odpoveď potvrdzuje, že dokument bol prijatý. Výsledky overenia a stav doručenia sa zobrazujú prostredníctvom webhookov alebo stavu dokumentu.
export QVALIA_API_KEY=YOUR_PRODUCTION_API_KEY
export QVALIA_BASE_URL=https://api.qvalia.comSledujte spracovanie a doručenie prostredníctvom webhookov alebo stavu dokumentu.
Jeden účet, šesť rozhraní API
API pre fakturáciu
Odosielajte a prijímajte faktúry a dobropisy prostredníctvom Peppolu s overením pred doručením.
Objednávka API
Odosielajte a prijímajte objednávky prostredníctvom Peppolu, vrátane odpovedí na objednávky, zmien a zrušení, čím zabezpečíte kompletný priebeh objednávacieho procesu.
Partner API
Vytvárajte a spravujte účty koncových zákazníkov a identifikátory Peppol priamo z vašej vlastnej platformy, a to pomocou webhookov pre udalosti súvisiace s dokumentmi.
OCR API
Extrahujte štruktúrované údaje z faktúr vo formáte PDF na účely kontroly a ďalšieho spracovania.
Rozšírené rozhranie API
Klasifikujte dokumenty a jednotlivé položky a obohacujte transakcie o štruktúrované údaje.
Účtovné API
Vytvárajte návrhy na zaúčtovanie na základe prichádzajúcich faktúr, aby ste ich mohli rýchlejšie skontrolovať a zaúčtovať.
Ďalšie možnosti pripojenia
Keď integrácia prostredníctvom API nie je tou správnou voľbou alebo potrebujete viac než len výmenu dokumentov.
- SFTP
Prenášajte súbory vo formáte XML alebo CSV cez SFTP, ak nie je možná integrácia prostredníctvom API. - ERP konektory
Hotové konektory pre bežné ERP a účtovné systémy. - Server Peppol MCP
Poskytnite agentom umelej inteligencie a klientom MCP štruktúrovaný prístup k transakciám, položkám, stavu dodávky a overovaniu. - Punchout
Prepojte katalóg dodávateľa so systémom obstarávania odberateľa. - Platba v rámci B2B
Pridajte do obchodu WooCommerce možnosť platby a fakturácie B2B s doručením cez Peppol.
Referenčná príručka Peppol pre vývojárov
Táto stránka sa venuje rozhraniam API spoločnosti Qvalia a dokumentom Peppol, ktoré prenášajú. Štandard Peppol, na ktorom sú založené, vrátane špecifikácií, pravidiel validácie a zoznamov kódov, je popísaný v našej dokumentácii k Peppol a v príručke k implementácii. Úplný zoznam koncových bodov nájdete na stránke api.qvalia.io. Normatívne špecifikácie Peppol zverejňuje organizácia OpenPeppol na stránke docs.peppol.eu.
Dokumenty Peppol a ich rozhrania API
| Dokument | Špecifikácia Peppol | Rozhranie API Qvalia |
| Faktúra | Peppol BIS Billing .0 | Rozhrania API pre faktúry |
| Dobropis | Peppol BIS Billing 3.0, dobropis | Rozhrania API pre dobropisy |
| Objednávka a potvrdenie objednávky | BIS Ordering Peppol BIS Ordering | API pre objednávky, API pre odpovede na objednávky |
| Objednávková zmluva | BIS Order Agreement Peppol BIS Order Agreement | Objednávanie rozhraní API pre dohody |
| Zmena a zrušenie objednávky | Peppol BIS Advanced Ordering | API pre zmeny objednávok, API pre zrušenie objednávok |
| Oznámenie o odoslaní | Peppol BIS Despatch Advice | API pre oznámenia o odoslaní |
| Katalóg | Peppol BIS Catalogue s odpoveďou | Rozhrania API katalógu |
| Stav dodávky | Odpoveď na úrovni správy a stav na úrovni správy | Rozhrania API pre odpovede na úrovni správ, rozhrania API pre stav na úrovni správ |
Overovanie a chyby
Zoznamy kódov
Adresovanie a vyhľadávanie
Testovanie a prevádzka
Pieskovisko
Otestujte si integráciu so svojimi vlastnými systémami bez toho, aby to malo vplyv na skutočných zákazníkov alebo finančné toky.
Verzovanie
Zmeny s nekompatibilnými dopadmi sa zavádzajú ako nová verzia API, a to s najmenej mesačným predstihom.
Stav systému
Zobraziť aktuálnu dostupnosť služieb a najnovšie informácie o poruchách.
Bezpečnosť
Prečítajte si, ako spoločnosť Qvalia pristupuje k informačnej bezpečnosti, zabezpečeniu nepretržitej prevádzky a budovaniu dôvery.
Peppol pre vašu firmu alebo pre vašich zákazníkov?
Prístupový bod Peppol
Chcete odosielať a prijímať dokumenty Peppol pre svoju firmu. Pripojte sa k prístupovému bodu Peppol spoločnosti Qvalia a integrujte ho so svojím ERP systémom alebo prostredníctvom API.
Partnerské riešenia
Ponúknite Peppol svojim zákazníkom prostredníctvom modelu, ktorý zodpovedá vašej úlohe. Využite integrovanú službu Peppol vo svojom produkte prostredníctvom API spoločnosti Qvalia alebo prevádzkujte hostovaný prístupový bod pod vlastnou identitou poskytovateľa služieb Peppol.
Otázky, ktoré kladú vývojári
Ďalšie pokyny k implementácii nájdete v našej znalostnej báze.
Existuje nejaké testovacie prostredie?
Áno. Testovacie prostredie na adrese api-test.qvalia.com používa samostatný kľúč API, takže môžete vykonávať testy bez toho, aby to malo vplyv na skutočných zákazníkov alebo finančné toky. Postupujte podľa podrobného návodu k rozhraniu Peppol API v sekcii Znalostná báza.
Aké formáty API podporuje?
Štandardne JSON alebo XML. Oba formáty využívajú štruktúry založené na UBL 2.1 pre príslušné koncové body dokumentov Peppol. Nastavte hodnoty Content-Type a Accept na application/json alebo application/xml. Informácie o typoch správ Peppol pre obchodné dokumenty a procesy podporované sieťou nájdete tu.
Ako sa mám prihlásiť?
Pomocou kľúča API v hlavičke „Authorization“ alebo pomocou dočasného tokenu (JWT), ktorý získate z koncového bodu /token pomocou svojho kľúča. Pre testovacie a produkčné prostredie získate samostatné kľúče.
Ako zistím, či bol dokument doručený?
Prihláste sa na odber webhookov alebo pravidelne kontrolujte API. Qvalia odosiela udalosti pri príchode dokumentu, pri jeho doručení a v prípade zlyhania doručenia. Informácie o odpovediach na úrovni Peppol nájdete v časti „Stav na úrovni správy “ v znalostnej báze.
Musím si transportný protokol Peppol implementovať sám?
Nie. Spoločnosť Qvalia prevádzkuje prístupový bod a zabezpečuje vyhľadávanie príjemcov, prenos cez AS4 a doručenie. Dokument odošlete do rozhrania API. Prečítajte si, ako služby SMP a SML na vyhľadávanie služieb lokalizujú prijímajúci koncový bod.
Môžem integrovať bez toho, aby som musel písať kód?
Áno. Použite ERP konektor alebo si vymieňajte súbory vo formáte XML alebo CSV prostredníctvom SFTP.
Ktoré dokumenty v systéme Peppol môžem vymieňať?
Faktúry, dobropisy, objednávky, odpovede na objednávky, dohody o objednávkach, zmeny a zrušenia objednávok, oznámenia o expedícii, katalógy a odpovede na úrovni správ. Tabuľka v časti „Referenčné údaje Peppol pre vývojárov“ uvádza špecifikáciu každého z nich. To, ktoré typy dokumentov vaše nastavenie obsahuje, závisí od vybranej služby a integrácie. Prehľad nájdete v článku „Aké sú typy správ v systéme Peppol? “.
Ako API nájde koncový bod príjemcu?
Qvalia využíva adresu Peppol ID príjemcu na vyhľadanie svojho vydavateľa metadát služieb (SMP) prostredníctvom vyhľadávača metadát služieb (SML). SMP vráti informácie o možnostiach dokumentu, procese a koncovom bode prenosu potrebné na doručenie. Prečítajte si článok „Peppol SMP a SML: ako funguje vyhľadávanie služieb“.
Čo sa stane, ak dokument neprejde validáciou Peppol?
Dokument s fatálnou chybou validácie je potrebné opraviť pred jeho odoslaním. Kód chyby identifikuje súbor pravidiel a časť dokumentu, ktorú je potrebné preskúmať. Pozrite si články Ako funguje validácia Peppol a Kódy pravidiel validácie Peppol.
Ako môžem skontrolovať, či má príjemca funkciu „ Peppol ID “ a či môže pracovať s dokumentmi?
Pomocou vyhľadávania „Peppol ID “ v systéme Qvalia môžete vyhľadať účastníkov a funkcie dokumentov uverejnené v adresári. Informácie o štruktúre a schémach identifikátorov nájdete v článku „Čo je Peppol ID?“ v znalostnej báze.