Anfrage per JSON

Du kannst für das guestoo Back-End zwischen zwei Darstellungsoptionen wählen. Die Screenshots in der Doku basieren auf dem "Klassischen Design".
Hier siehst Du die Unterschiede, damit Du dich auch im "Modernen Design" zurecht findest: » guestoo Back-End-Design
Inhalte dieser Seite:

Anfrage per JSON

Folgendes Beispiel zeigt eine einfache (minimale) Anfrage an die Scansio-API. Hierzu wurden so wenig Parameter wie möglich verwendet. Das Bild befindet sich als Base64-codierter String im JSON-Body.

Der Parameter mit dem Konfigurationsnamen wird ebenfalls im JSON mitgegeben. Diese Art der Parameter-Mitgabe ist auch für alle anderen Parameter möglich.

Es wird eine vordefinierte Konfiguration mit der Bezeichnung "scansioInvoiceConfiguration" genutzt. Diese Konfiguration dient dazu einige Werte aus Belegen und Rechnungen zu extrahieren.

Die Anfrage per CURL würde folgendermaßen aussehen. Bitte beachte, dass der Base64 String verkürzt wurde.

    curl \
    -H 'Authorization: Bearer <geheimer_api_schlüssel>' \
    -H 'Content-Type: application/json' \
    -d '{"file":"+8n5l1P/ZKRvevziH17563BVoWZ1X3p2/0LqkyOdU+O3Pn...",\
        "configurationName":"scansioInvoiceConfiguration"}' \
    https://api.scansio.de/scan/v1/file

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/operation/scanImageWithJsonUsingPOST) 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.