API-Scan

Der API-Scan macht aus einem PDF über einen REST-Aufruf eine realistisch gescannte Kopie – passend für automatisierte Abläufe und App-Integrationen. Auftrag anlegen, PDF hochladen, Status abfragen oder auf den Webhook warten: drei Schritte, aus jeder Umgebung und jeder Sprache, die eine HTTP-Anfrage senden kann. Farbraum, Auflösung, Drehung, Weichzeichnung, Rauschen, Helligkeit, Kontrast und Rand sind frei einstellbar.

Ablauf eines Aufrufs

  1. Auftrag anlegen

    POST /v1/scan-jobs

    Senden Sie Ihre config und optional eine webhookUrl; zurück kommen eine jobID und eine vorsignierte uploadURL.

  2. PDF hochladen

    PUT {uploadURL}

    Die Datei per PUT direkt an die vorsignierte S3-Adresse aus dem vorigen Schritt schicken – ohne Token.

  3. Gescannte Kopie abholen

    GET /v1/scan-jobs/{jobID}

    Status abfragen oder auf den Webhook warten; sobald der Auftrag completed ist, über downloadURL herunterladen.

Wofür es sich eignet

Stapelausgabe im Backend

Verträge, Rechnungen und Berichte, die auf dem Server entstehen, laufen direkt durch den Scan-Effekt, ohne dass jemand den Vorgang auf der Webseite von Hand wiederholt.

In einem bestehenden System

Ergänzen Sie CRM, ERP oder Ticketsystem um eine Aktion „gescannte Kopie exportieren“, die die API aufruft.

Automatisierte Abläufe

CI, n8n, Zapier und Ähnliches starten einen Auftrag bei einem Ereignis, und der Webhook übergibt nach Abschluss an den nächsten Schritt.

Große Dateiwarteschlangen

Aufträge sind asynchron: einmal angelegt, wird jeder für sich verarbeitet, und der Fortschritt bleibt über status und createdAfter abrufbar.

Sprachen und Umgebungen

TypeScriptfetch / axios
Node.jsfetch / undici
Pythonrequests / httpx
Gonet/http
PHPcURL / Guzzle
Rubynet/http
JavaHttpClient
cURLKommandozeile / CI
MehrJeder HTTP-Client

Die API ist gewöhnliches HTTP und JSON – jede Sprache und jede Automatisierungsplattform, die eine Anfrage senden kann, kann sie aufrufen.

Codebeispiele

API Bearer Token

Das Token gehört zu Ihrem Konto und lässt sich jederzeit neu erzeugen. Der API-Scan setzt ein Pro-Konto voraus: ohne gültiges Token antwortet die API mit 401, ohne die Pro-Rolle mit 403.

Ausprobieren

Stellen Sie die Parameter ein, sehen Sie dem Anfragerumpf beim Mitwachsen zu und schicken Sie dann die drei Aufrufe an die API.

Scan-Parameter

Ein Testlauf ruft die API mit Ihrem Token auf und braucht ein Pro-Konto; Parameter und Anfragerumpf können Sie frei ansehen.

POST/v1/scan-jobs
{
  "config": {
    "rotate": 1,
    "rotate_var": 0.5,
    "colorspace": "gray",
    "blur": 0,
    "noise": 0,
    "border": false,
    "brightness": 1.3,
    "contrast": 1.3,
    "resolution": 150,
    "output_format": "image/jpeg"
  }
}

Scan-Auftragsinformationen

Beispiel
{
  "jobID": "3f9c1e64-0000-4000-8000-00000000a71b",
  "userID": "8f21c4b0-0000-4000-8000-000000004a17",
  "createdAt": 1724409600,
  "status": "completed",
  "inputUploadedAt": 1724409601,
  "completedAt": 1724409602,
  "numPages": 6,
  "downloadURL": "https://…/output/3f9c.pdf?X-Amz-…"
}

API-Referenz

MethodePfadBeschreibung
POST/v1/scan-jobsLegt einen Scan-Auftrag an. Senden Sie config und optional webhookUrl; zurück kommt das Auftragsobjekt mit dem Status created und einer vorsignierten uploadURL.
PUT{uploadURL}Die vorsignierte S3-Adresse aus dem vorigen Schritt, nicht auf api.lookscanned.ioLädt das Quell-PDF mit Content-Type: application/pdf und Content-Length hoch. Die Adresse trägt ihre eigene Signatur – fügen Sie keinen Authorization-Header hinzu.
GET/v1/scan-jobs/{jobID}Liest einen einzelnen Auftrag, zum Abfragen des Fortschritts. Bei created enthält er uploadURL, bei completed downloadURL.
GET/v1/scan-jobsListet Ihre eigenen Aufträge auf, gefiltert nach jobID, status oder createdAfter.
Statuscreatedprocessingcompletedfailed
  • 401 kein gültiges Token
  • 403 das Konto ist nicht Pro
  • 404 Auftrag nicht vorhanden

Anfragerumpf

FeldTypStandardBeschreibung
webhookUrlstring · —Wird einmal aufgerufen, sobald der Auftrag fertig ist – dann müssen Sie nicht abfragen.
config.colorspace'gray' | 'sRGB' · graygrayFarbraum des Ausgabebilds; gray ist ein Schwarzweiß-Scan.
config.resolutionnumber · 7272Auflösung des Ausgabebilds in DPI.
config.rotatenumber · —Drehung des gesamten Dokuments in Grad.
config.rotate_varnumber · —Spanne der zufälligen Drehung je Seite in Grad – der Eindruck von schief aufgelegtem Papier.
config.blurnumber · 00Stärke der Weichzeichnung.
config.noisenumber · 00Stärke des Rauschens.
config.brightnessnumber · 11Helligkeit; 1 lässt sie unverändert.
config.contrastnumber · 11Kontrast; 1 lässt ihn unverändert.
config.borderboolean · falsefalseOb die Seite einen Scan-Rand erhält.
config.output_format'image/png' | 'image/jpeg' · image/jpegimage/jpegBildformat, in das die Seiten gerendert werden.

Alle Felder sind optional. Die Startwerte unter „Ausprobieren“ – Auflösung 150, Drehung 1, Helligkeit und Kontrast 1,3 – sind die von der Web-App empfohlene Kombination, nicht die Standardwerte der API.

Felder im Auftragsobjekt, auf die es ankommt

status
created / processing / completed / failed – entscheidet, ob die beiden folgenden Adressen vorhanden sind.
uploadURL
Nur solange created. Eine vorsignierte Upload-Adresse mit begrenzter Gültigkeit.
downloadURL
Erst wenn completed. Eine vorsignierte Download-Adresse mit begrenzter Gültigkeit.
inputUploadedAt / completedAt
Wann der Upload der Quelle fertig war und wann der Auftrag fertig war; die Differenz ist die Verarbeitungsdauer.

Häufige Fragen

Braucht der API-Scan Pro?

Ja. Ohne gültiges Token antwortet die API mit 401, und ein Konto ohne die Pro-Rolle bekommt 403. Nach dem Upgrade und der Anmeldung steht das Token auf dieser Seite.

Woran erkenne ich, dass ein Auftrag fertig ist?

Auf zwei Wegen: GET /v1/scan-jobs/{jobID} abfragen, oder beim Anlegen eine webhookUrl mitgeben und den Dienst einmal zurückrufen lassen.

Ist das Ergebnis dasselbe wie beim Scannen auf der Webseite?

Ja. Beide nutzen dieselbe Umsetzung des Scan-Effekts, und Farbraum, Auflösung, Drehung, Weichzeichnung, Rauschen, Helligkeit, Kontrast und Rand in config sind die gleichnamigen Optionen der Webseite: gleiche Parameter, gleiches Ergebnis. Unterschiedlich ist nur der Ort der Verarbeitung – lokal auf der Seite, entfernt über die API.

Kann ich die Upload- und Download-Adressen speichern und wiederverwenden?

Besser nicht. uploadURL und downloadURL sind vorsignierte Adressen mit begrenzter Gültigkeit; nach Ablauf müssen Sie den Auftrag erneut lesen, um neue zu erhalten.

Wie lange dauert ein Auftrag?

Das hängt von Seitenzahl und Auflösung ab. Wenige Seiten sind meist in Sekunden fertig; höhere Auflösungen und längere Dokumente dauern länger. Die Differenz zwischen inputUploadedAt und completedAt ist die tatsächliche Dauer.

Was tun, wenn ein Auftrag fehlschlägt?

Der Status wechselt auf failed. Übliche Ursachen sind eine Datei, die kein gültiges PDF ist, Verschlüsselungsbeschränkungen oder ein abgebrochener Upload. Prüfen Sie, ob sich die Datei öffnen lässt, und legen Sie einen neuen Auftrag an.

Kann ich frühere Aufträge nachschlagen?

Ja. GET /v1/scan-jobs listet Ihre eigenen Aufträge und lässt sich nach jobID, status und createdAfter filtern – genug für einen Abgleich oder einen erneuten Download.