Dokument einreichen
const url = 'https://api.legentio.com/v1/scans?environment=prod';const form = new FormData();form.append('file', 'file');form.append('documentType', 'rechnung');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url 'https://api.legentio.com/v1/scans?environment=prod' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: multipart/form-data' \ --form file=@file \ --form documentType=rechnungNimmt ein einzelnes PDF entgegen, legt einen Verarbeitungslauf an und plant die Verarbeitung ein. Kehrt sofort mit 202 Accepted zurück – ohne auf das Ergebnis zu warten. Die Antwort enthält einen Location-Header und eine statusUrl, unter der sich der Lauf abfragen lässt.
Idempotenz: Über den optionalen Header Idempotency-Key lässt sich ein erneuter Versand desselben Dokuments absichern. Wird derselbe Schlüssel mit einer identischen Anfrage erneut gesendet, antwortet die API mit 200 und dem bereits existierenden Lauf (statt einen neuen anzulegen) – das ist der Wiederherstellungspfad für Clients, die die erste Antwort verloren haben. Wird derselbe Schlüssel mit einer abweichenden Anfrage verwendet, ist die Antwort 409.
Authorizations
Abschnitt betitelt „Authorizations“Parameters
Abschnitt betitelt „Parameters“Query Parameters
Abschnitt betitelt „Query Parameters“Zielumgebung des Laufs. Pflichtparameter – nicht vorbelegt, damit nie unklar ist, ob ein Dokument nach Produktiv oder Test ging. prod-Läufe speisen den produktiven Auslieferungs-Feed; test-Läufe werden identisch verarbeitet, bleiben aber aus dem Standard-Feed und den Dashboard-Kennzahlen heraus.
Header Parameters
Abschnitt betitelt „Header Parameters“Frei wählbarer Schlüssel zur Absicherung von Wiederholungen. Je nach Server-Konfiguration kann er verpflichtend sein.
Request Bodyrequired
Abschnitt betitelt „Request Bodyrequired“object
Das einzureichende PDF (nur application/pdf).
Der Slug des Dokumenttyps, gegen den erkannt wird.
Example
rechnungResponses
Abschnitt betitelt „Responses“Idempotente Wiederholung – die Anfrage war mit demselben Idempotency-Key bereits erfolgreich. Es wird der bestehende Lauf mit seinem aktuellen Status zurückgegeben, ohne einen neuen anzulegen.
object
Kennung des Laufs; wird für alle weiteren Abfragen verwendet.
Bei einem neuen Lauf stets processing. Bei einer idempotenten Wiederholung der aktuelle Status des bestehenden Laufs.
Absolute URL zum Abfragen des Laufs (GET /v1/scans/{scanId}).
Example
{ "scanId": "k17c9c8f2a1b3d4e5f6a7b8c9d0e1f2", "status": "processing", "statusUrl": "https://api.legentio.com/v1/scans/k17c9c8f2a1b3d4e5f6a7b8c9d0e1f2"}Angenommen – Verarbeitung eingeplant. Ein neuer Lauf wurde angelegt.
object
Kennung des Laufs; wird für alle weiteren Abfragen verwendet.
Bei einem neuen Lauf stets processing. Bei einer idempotenten Wiederholung der aktuelle Status des bestehenden Laufs.
Absolute URL zum Abfragen des Laufs (GET /v1/scans/{scanId}).
Example
{ "scanId": "k17c9c8f2a1b3d4e5f6a7b8c9d0e1f2", "status": "processing", "statusUrl": "https://api.legentio.com/v1/scans/k17c9c8f2a1b3d4e5f6a7b8c9d0e1f2"}Headers
Abschnitt betitelt „Headers“URL zum Abfragen des Laufstatus (identisch mit statusUrl).
Ungültige Anfrage – z. B. fehlender/ungültiger environment-Parameter, keine multipart/form-data, kein PDF, fehlender Dokumenttyp-Slug, zu große Datei oder fehlender Pflicht-Idempotency-Key.
object
Menschenlesbare Fehlermeldung (deutsch).
Example
{ "error": "Dokumenttyp nicht gefunden."}API-Schlüssel fehlt oder ist ungültig.
object
Menschenlesbare Fehlermeldung (deutsch).
Example
{ "error": "Dokumenttyp nicht gefunden."}Der API-Schlüssel gehört zu keiner Organisation.
object
Menschenlesbare Fehlermeldung (deutsch).
Example
{ "error": "Dokumenttyp nicht gefunden."}Der angegebene Dokumenttyp wurde nicht gefunden.
object
Menschenlesbare Fehlermeldung (deutsch).
Example
{ "error": "Dokumenttyp nicht gefunden."}Der Idempotency-Key wurde bereits mit einer abweichenden Anfrage (andere Datei oder andere Umgebung) verwendet.
object
Menschenlesbare Fehlermeldung (deutsch).
Example
{ "error": "Dokumenttyp nicht gefunden."}Für den Dokumenttyp ist in der gewählten Umgebung noch kein einsatzbereites Schema eingerichtet.
object
Menschenlesbare Fehlermeldung (deutsch).
Example
{ "error": "Dokumenttyp nicht gefunden."}Interner Serverfehler.
object
Menschenlesbare Fehlermeldung (deutsch).
Example
{ "error": "Dokumenttyp nicht gefunden."}