Folgendes Beispiel zeigt eine umfangreichere Anfrage an die Scansio-API. Hierzu wurden einige der möglichen Parameter verwendet.
Es wird eine vordefinierte Konfiguration mit der Bezeichnung "scansioInvoiceConfiguration" genutzt. Diese Konfiguration dient dazu einige Werte aus Belegen und Rechnungen zu extrahieren.
Die URL-Parameter haben folgende Bedeutung:
id:
Dieser Parameter kann von Dir frei definiert oder auch weggelassen werden. Der Wert wird in dem Response wieder zurückgegeben und kann eine Hilfe bei der Zuordnung von Anfragen sein.
returnDataResults:
Gibt an, ob die OCR-Ergebnisse, die während der Extraktion erzeugt bzw. genutzt wurden, wieder in dem Response zurückgegeben werden sollen. Die Ergebnisse sind komprimiert und Base64-codiert und können bei nachfolgenden Anfragen an eine spezielle API-Schnittstelle gesendet werden. Das erhöht die Geschwindigkeit des Scansio-Services enorm, da somit vor der Extraktion der Werte kein OCR mehr ausgeführt werden muss.
createImages
Definiert, ob von den extrahierten Werten Bildausschnitte generiert und in dem Response zurückgegeben werden sollen. Diese können nützlich sein, um die API-Ergebnisse zu validieren.
Die Anfrage per CURL würde folgendermaßen aussehen:
curl \
-H 'Authorization: Bearer <geheimer_api_schlüssel>' \
-F 'file=@/home/your/local/file.jpg' \
https://api.scansio.de/scan/v1/file/body\
?configurationName=scansioInvoiceConfiguration\
&id=BeispielId12345\
&returnDataResults=true\
&createImages=true
Das Ergebnis im Response wird im Abschnitt [Struktur von API-Antworten](/usage/responses) und in unserer [REST API-Dokumentation](https://api.scansio.de/doc/index.html#tag/scan-controller) ausführlich beschrieben. Bitte klicke auf der Seite zunächst im Responses-Bereich auf "200 OK". Darauf folgend kannst du dich durch die Json-Hierarchie klicken und Informationen zu den einzelnen Attributen anzeigen.