API docs by Redocly

be-document-service (2.0)

Download OpenAPI specification:Download

Der be-document-service stellt eine Integration der OCR mit einer einheitlichen API (be invoice OCR Standard JSON Format) bereit.

Dies ermöglicht Dontenwill Verbesserung, Änderungen und den kompletten Austausch des zugrundeliegende OCR-Service durchzuführen, ohne dass Anpassungen den jeweiligen Kundeninstanzen notwendig sind.

Änderungen 2.0:

  • v2: Neue Unterstützung von Auftragsbestätigungen 'orderConfirmation'. Änderung der ID von invoiceCustomerId zu customerId.
  • v1: Die Nutzung der Version 1 von Rechnungen ist weiterhin möglich, jedoch wird empfohlen auf die Version 2 zu migrieren. Zusätzlich können ab der Version 2.0 üner der v1 API auch Auftragsbestätigungen bearbeitet werden. Diese werden immer im neuen Format zurückgegeben.

Prüft den Service auf Verfügbarkeit

Ermöglich ohne Authentifizierung die Prüfung ob der Endpu nkt erreichrbar ist.

Responses

Response samples

Content type
application/json
{
  • "alive": true
}

Startet eine OCR Analyse

Der Aufruf erfordert die Übergabe einer Rechnung als PDF-Datei. Die Verarbeitung erfolgt asynchron im Hintergrund. Der Rückgabewert ist nach einer erfolgreichen Annahme 202. Die Rechnung wird mit einer übergebenen ID im Pfad identifiziert.

Der Client muss in regelmäßigen Abständen von ca 3–5 Sekunden mit dem Aufruf der GET Route prüfen, ob die Rechnung mit der ID verarbeitet wurde.

Beispiel-Code für eine Rechnungsanalyse

let response
await post(`https://.../api/ocr/v1/document/123/analyze?docType=invoice`, file);
do {
  await new Promise(r => setTimeout(r, 5000));
  response = await get(`https.../api/ocr/v1/document/123`);
} while(response.status == 202);
Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: ad463052-b3b9-11ed-afa1-0242ac120002

ID des Dokumentes, darf nur Alphanumerische Zeichen sowie _ und - enthalten.

query Parameters
docType
required
string
Value: "invoice"

Dokumenttyp der übergebenen PDF Datei. Aktuell wird nur invoice unterstützt.

Request Body schema: application/pdf
required

Die zu analysierende Rechnung als PDF Datei.

string <binary>

Responses

Löschen des Dokumentes und des Ergebnis.

Diese Methode löscht sowohl das PDF als auch das Ergebnis.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: ad463052-b3b9-11ed-afa1-0242ac120002

ID des Dokumentes, darf nur Alphanumerische Zeichen sowie _ und - enthalten.

Responses

Abruf des analysierten Dokuments und optionales löschen der Ergebnisse

Diese Methode kombiniert die Abfrage der Ergebnisse und lösht nach erfolgreicher Abfrage alle wenn das Dokument noch nicht verabreitet wurde.

Nach der erfolgreichen Analyse wird 200 und das Dokument zurückgeliefert.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: ad463052-b3b9-11ed-afa1-0242ac120002

ID des Dokumentes, darf nur Alphanumerische Zeichen sowie _ und - enthalten.

query Parameters
delete
boolean

Flag, wenn vorhanden werden nach dem Abruf des Ergebniss alle Informationen dazu geklscht.

Responses

Response samples

Content type
application/json
{
  • "documents": [
    ]
}

Abruf des analysierten Dokuments, liefert das Dokument in der Schema Version v1 zurück.

Diese Methode liefert 202 zurück wenn das Dokument noch nicht verabreitet wurde.

Nach der erfolgreichen Analyse wird 200 und das Dokument zurückgeliefert.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: ad463052-b3b9-11ed-afa1-0242ac120002

ID des Dokumentes, darf nur Alphanumerische Zeichen sowie _ und - enthalten.

Responses

Response samples

Content type
application/json
{
  • "documents": [
    ]
}

Abruf des analysierten Dokuments. Liefert das Dokument in der Schema Version v2 zurück.

Diese Methode liefert 202 zurück wenn das Dokument noch nicht verabreitet wurde.

Nach der erfolgreichen Analyse wird 200 und das Dokument zurückgeliefert.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: ad463052-b3b9-11ed-afa1-0242ac120002

ID des Dokumentes, darf nur Alphanumerische Zeichen sowie _ und - enthalten.

Responses

Response samples

Content type
application/json
{
  • "documents": [
    ]
}