Vstup
Faktúra vo formáte PDF alebo XML
Jeden súbor na jednu požiadavku, zakódovaný v Base64
Výstup
Štruktúrované údaje z faktúr
Údaje v hlavičke a položky
Spracovanie
Asynchrónny
Dotaz s identifikátorom dotazu, najviac raz za 30 sekúnd
Prístup
Testovacie prostredie a produkčné prostredie
Fakturuje sa samostatne, vďaka podpore zo strany spoločnosti Qvalia
Zadajte faktúru v dvoch požiadavkách
Súbor zakódujte pomocou Base64, odošlite ho s nastavením „enrichmentTypes“ na „capture“ a výsledok zachyťte pomocou ID dotazovania z odpovede.
- Jeden súbor s faktúrou na jednu žiadosť, vo formáte PDF alebo XML
- Do názvu súboru zahrňte príponu súboru
- Vykonávajte dotazovanie najviac raz za 30 sekúnd
- Získajte iba výsledok zachytenia pomocou cesty „enrichmentType“
● ● ●
Žiadosť v testovacom prostredí: zaznamenať faktúru
# capture-request.json
{
"fileName": "invoice.pdf",
"fileContent": "<Base64-encoded PDF>",
"enrichmentTypes": "capture"
}
curl -X POST \
"https://api-test.qvalia.com/enrichment/$ACCOUNT_REG_NO/invoice" \
-H "Authorization: $QVALIA_API_KEY" \
-H "Content-Type: application/json" \
-d @capture-request.json
# Collect the result with the pollingId
curl "https://api-test.qvalia.com/enrichment/$ACCOUNT_REG_NO/$POLLING_ID/capture" \
-H "Authorization: $QVALIA_API_KEY"Skúste to sami na svojej faktúre vo formáte PDF
Nahrajte faktúru vo formáte PDF s veľkosťou do 4,5 MB do bezplatného testu na rozpoznávanie dokumentov od spoločnosti Qvalia a pozrite si, aké štruktúrované údaje vám systém poskytne. Nie je potrebná žiadna integrácia a ak nemáte po ruke žiadny súbor, je k dispozícii vzorová správa.
Ako funguje digitalizácia faktúr
Zaznamenávanie prebieha asynchrónne. Nahrajete súbor, Qvalia ho spracuje a výsledok si vyzdvihnete, keď bude pripravený.
Nahrať
Na koncový bod pre faktúry odošlite jednu faktúru vo formáte PDF alebo XML na jednu požiadavku, zakódovanú pomocou Base64.
Zachytávanie
Qvalia načíta dokument a extrahuje údaje z hlavičky a položky faktúry do štruktúrovaných údajov faktúry.
Anketa
Použite identifikátor dotazu. Hodnota 202 znamená, že spracovanie pokračuje, a hodnota 200 vráti výsledok.
Recenzia
Skontrolujte chyby a varovania, ktoré sa vrátili pre každý dokument, skôr než sa údaje posunú ďalej vo vašom procese.
Zaznamenávanie koncových bodov
Všetky cesty sú relatívne voči základnej URL adresy sandboxu alebo produkčného prostredia a sú viazané na registračné číslo vášho účtu.
| Žiadosť | Koncový bod | Vrátenie tovaru |
| Nahrať faktúru | POST /enrichment/{accountRegNo}/invoice | ID ankety |
| Zobraziť všetky výsledky | GET /enrichment/{accountRegNo}/{pollingId} | Stav alebo výsledky podľa typu |
| Získať výsledok zachytenia | GET /enrichment/{accountRegNo}/{pollingId}/capture | Výsledok snímania |
Pieskovisko: api-test.qvalia.com. Produkcia: api.qvalia.com. Funkcia Capture je súčasťou rozhrania Enrichment API, ktoré sa fakturuje samostatne a aktivuje ho technická podpora spoločnosti Qvalia.
Čo je potrebné zohľadniť pri integrácii
Zaznamenávanie prebieha mimo vášho cyklu požiadaviek. Tieto body si naplánujte ešte pred spustením do prevádzky.
- Asynchrónne spracovanie
Uložte identifikátor dotazovania spolu s dokumentom a vykonávajte dotazovanie najviac raz za 30 sekúnd. - Chyby a upozornenia
Dokumenty s chybami smerujte na ručné preskúmanie a upozornenia nechajte viditeľné pre používateľa. - Limity frekvencie
Počet limitov sa počíta na jeden účet vo všetkých rozhraniach API služby Qvalia. V prípade chyby 429 počkajte, kým uplynie časový interval Retry-After. - Samostatné prostredia
Pred prechodom na api.qvalia.com vykonajte testovanie na api-test.qvalia.com. - Neplatné identifikačné čísla hlasovania
Chyba 404 znamená, že identifikačné číslo hlasovania je neznáme alebo jeho platnosť vypršala. Ak sa výsledok nikdy nezaznamenal, nahrajte dokument znovu.
Vyberte si východiskový bod
Vo webovej aplikácii
OCR faktúr
Zaznamenávajte faktúry vo formáte PDF v webovej aplikácii Qvalia bez nutnosti vytvárať integráciu.
Zverejňovanie a klasifikácia
Rozšírené rozhranie API
Zverejňovanie návrhov a klasifikácia podľa UNSPSC. Capture je podporný krok, ktorý pripravuje faktúry vo formáte PDF pre obidve účely.
Začíname
Rýchly úvod do API
Nastavte prístup k API a odošlite svoju prvú požiadavku – krok za krokom.
Často kladené otázky k rozhraniu API pre optické rozpoznávanie faktúr (OCR)
Čo je rozhranie API pre optické rozpoznávanie faktúr (OCR)?
REST API, ktoré prevádza faktúry vo formáte PDF na štruktúrované údaje o faktúrach. Funguje ako typ zachytávania v rámci rozhrania Enrichment API.
Aké súbory môžem poslať?
Na jednu požiadavku jedna faktúra vo formáte PDF alebo XML, zakódovaná pomocou Base64 v poli „fileContent“. Do poľa „fileName“ uveďte príponu súboru.
Čo vráti toto API?
Štruktúrované údaje z faktúry obsahujúce údaje v hlavičke a položky faktúry spolu s chybami a upozorneniami týkajúcimi sa dokumentu.
Koľko trvá zachytenie?
Spracovanie prebieha asynchrónne, takže dĺžka trvania sa líši v závislosti od dokumentu. Kontrolujte koncový bod s výsledkom najviac raz za 30 sekúnd, kým nedostanete stavový kód 200.
V čom sa rozhranie OCR API líši od služby OCR pre faktúry?
OCR faktúr sa vykonáva vo webovej aplikácii Qvalia. OCR API umožňuje vášmu systému spracovávať údaje prostredníctvom rozhrania REST API.
Je tam pieskovisko?
Áno. Na testovanie použite adresu api-test.qvalia.com a v produkčnom prostredí adresu api.qvalia.com.
Je rozhranie OCR API súčasťou iných rozhraní Qvalia API?
Nie. Funkcia Capture je súčasťou rozhrania Enrichment API, ktoré sa fakturuje samostatne. Podpora spoločnosti Qvalia ju aktivuje pre váš účet.
