Vstup
Faktura ve formátu PDF nebo XML
Jeden soubor na jeden požadavek, zakódovaný v Base64
Výstup
Strukturovaná data faktur
Údaje v záhlaví a jednotlivé položky
Zpracování
Asynchronní
Dotaz s identifikátorem dotazu, maximálně každých 30 sekund
Přístup
Testovací prostředí a produkční prostředí
Účtováno zvlášť, díky podpoře Qvalia
Zaznamenejte fakturu ve dvou krocích
Soubor zakódujte pomocí Base64, odešlete jej s parametrem `enrichmentTypes` nastaveným na `capture` a výsledek shromážděte pomocí ID dotazu z odpovědi.
- Jeden soubor s fakturou na jednu žádost, ve formátu PDF nebo XML
- Do názvu souboru (fileName) zahrňte příponu souboru
- Provádějte dotazování nejvýše jednou za 30 sekund
- Získejte pouze výsledek zachycení pomocí cesty „enrichmentType“
● ● ●
Žádost v testovacím prostředí: zachycení faktury
# 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"Zkuste to sami na své vlastní faktuře ve formátu PDF
Nahrajte fakturu ve formátu PDF o velikosti až 4,5 MB do bezplatného testu rozpoznávání dat služby Qvalia a podívejte se, jaká strukturovaná data vám nástroj vrátí. Není potřeba žádná integrace a pokud nemáte po ruce žádný soubor, je k dispozici vzorová zpráva.
Jak funguje digitalizace faktur
Zpracování probíhá asynchronně. Soubor nahrajete, Qvalia jej zpracuje a výsledek si vyzvednete, až bude hotový.
Nahrát
Na koncový bod pro faktury odešlete jednu fakturu ve formátu PDF nebo XML na jeden požadavek, kódovanou pomocí Base64.
Zachycení
Qvalia načte dokument a extrahuje údaje z hlavičky a jednotlivé položky do strukturovaných fakturačních údajů.
Anketa
Použijte identifikátor dotazu. Hodnota 202 znamená, že zpracování pokračuje, zatímco hodnota 200 vrací výsledek.
Recenze
Než data postoupí dále ve vašem procesu, zkontrolujte chyby a varování vrácené u každého dokumentu.
Zaznamenat koncové body
Všechny cesty jsou relativní vůči základní URL pískoviště nebo produkčního prostředí a jsou vázány na registrační číslo vašeho účtu.
| Žádost | Koncový bod | Vrácení zboží |
| Nahrát fakturu | POST /enrichment/{accountRegNo}/invoice | ID ankety |
| Zobrazit všechny výsledky | GET /enrichment/{accountRegNo}/{pollingId} | Stav, resp. výsledky podle typu |
| Získejte výsledek snímání | GET /enrichment/{accountRegNo}/{pollingId}/capture | Výsledek snímání |
Pískoviště: api-test.qvalia.com. Produkce: api.qvalia.com. Funkce Capture je součástí rozhraní Enrichment API, které se účtuje samostatně a aktivuje jej technická podpora společnosti Qvalia.
Na co se při integraci připravit
Zaznamenávání probíhá mimo váš cyklus požadavků. Tyto aspekty si naplánujte ještě před spuštěním do ostrého provozu.
- Asynchronní zpracování
Uložte identifikátor dotazu spolu s dokumentem a provádějte dotazování nejvýše jednou za 30 sekund. - Chyby a varování
Dokumenty tras obsahující chyby předávejte k ruční kontrole a varování nechte uživateli viditelná. - Limity volání
Limity se počítají na jeden účet napříč všemi API rozhraními Qvalia. V případě chyby 429 počkejte po dobu stanovenou v poli Retry-After. - Samostatná prostředí
Než přejdete na api.qvalia.com, proveďte testování na api-test.qvalia.com. - Neplatná ID hlasování
Chyba 404 znamená, že ID hlasování je neznámé nebo již vypršela jeho platnost. Pokud výsledek nebyl nikdy zaznamenán, nahrajte dokument znovu.
Vyberte si výchozí bod
Ve webové aplikaci
OCR faktur
Zaznamenávejte faktury ve formátu PDF v webové aplikaci Qvalia bez nutnosti vytvářet integraci.
Zveřejňování a zařazování
Rozšiřující API
Zadávání návrhů a klasifikace podle UNSPSC. Capture je podpůrný krok, který připravuje faktury ve formátu PDF pro oba účely.
Začínáme
Rychlý start s API
Nastavte přístup k API a odešlete svůj první požadavek – krok za krokem.
Často kladené otázky k API pro optické rozpoznávání faktur (OCR)
Co je to rozhraní API pro optické rozpoznávání faktur (OCR)?
REST API, které převádí faktury ve formátu PDF na strukturovaná fakturační data. Funguje jako typ snímání v rámci rozšiřujícího API.
Jaké soubory mohu poslat?
Jedna faktura ve formátu PDF nebo XML na jeden požadavek, zakódovaná v kódování Base64 v poli „fileContent“. Do pole „fileName“ uveďte příponu souboru.
Co vrací API?
Strukturovaná data faktury obsahující údaje v záhlaví a položky, včetně chyb a varování týkajících se daného dokladu.
Jak dlouho trvá snímání?
Zpracování probíhá asynchronně, takže doba zpracování se u jednotlivých dokumentů liší. Dotazujte se na koncový bod s výsledky nejvýše jednou za 30 sekund, dokud nezískáte stavový kód 200.
V čem se rozliší rozhraní OCR API od služby OCR pro faktury?
OCR faktur se provádí v webové aplikaci Qvalia. OCR API umožňuje vašemu systému provádět rozpoznávání prostřednictvím REST API.
Je tam pískoviště?
Ano. Pro testování použijte adresu api-test.qvalia.com a pro produkční provoz adresu api.qvalia.com.
Je rozhraní OCR API součástí jiných rozhraní API služby Qvalia?
Ne. Funkce Capture je součástí rozhraní Enrichment API, které se účtuje samostatně. Podpora Qvalia ji pro váš účet aktivuje.
