Zum Hauptinhalt springen

Nächstes Tool finden

Dokumentation/Erste Schritte/API-Schnellstart: Ihre erste Datei konvertieren
Erste Schritte

API-Schnellstart: Ihre erste Datei konvertieren

Erstellen Sie einen API-Schlüssel, senden Sie eine Datei, warten Sie auf den Job und laden Sie das Ergebnis herunter – mit Anfragen zum Kopieren und Einfügen.

Kurze Antwort

Erstellen Sie unter Dashboard → API & Schlüssel einen Schlüssel und senden Sie dann POST https://maxscanner.app/api/v1/jobs/ mit einer öffentlichen Datei-URL, einem Dateinamen und dem Zielformat. Die API gibt sofort eine jobId zurück; fragen Sie GET /api/v1/jobs/{jobId}/ alle paar Sekunden ab, bis status "completed" lautet, und laden Sie dann output.downloadUrl innerhalb von fünf Minuten herunter.

Schnellstart

  1. 1Öffnen Sie Dashboard → API & Schlüssel, wählen Sie „API-Schlüssel erstellen“, aktivieren Sie „Dateien verarbeiten“ und kopieren Sie den Schlüssel (er wird nur einmal angezeigt).
  2. 2Speichern Sie den Schlüssel in einer Umgebungsvariablen wie MAXSCANNER_API_KEY – niemals in clientseitigem Code.
  3. 3Senden Sie POST /api/v1/jobs/ mit url, filename und format. Notieren Sie sich die jobId aus der 202-Antwort.
  4. 4Rufen Sie GET /api/v1/jobs/{jobId}/ alle 2–10 Sekunden ab, bis status completed oder failed ist.
  5. 5Laden Sie output.downloadUrl sofort herunter: Der signierte Link läuft nach fünf Minuten ab.

Bevor Sie beginnen

Jede Anfrage geht an https://maxscanner.app/api/v1/ und überträgt den Schlüssel als Bearer-Token. Anfrage-URLs enden mit einem Schrägstrich: Eine URL ohne Schrägstrich erhält eine 308-Weiterleitung, der die meisten HTTP-Clients folgen; mit Schrägstrich sparen Sie sich jedoch einen Roundtrip.

Der Free-Tarif erlaubt 10 Anfragen pro Tag und 100 pro Monat – genug, um eine Integration zu entwickeln und zu testen. Kostenpflichtige Tarife arbeiten stattdessen mit monatlichen Credits; jeder Endpunkt kostet 0 bis 3 Credits.

  • Basis-URL: https://maxscanner.app/api/v1/
  • Header: Authorization: Bearer <your key>
  • Body: JSON mit Content-Type: application/json
  • Dateien: bis zu 50 MB per URL-Import oder Direkt-Upload

Eine Word-Datei in PDF konvertieren

Der Jobs-Endpunkt wählt den passenden Prozessor anhand des Eingabe- und Ausgabeformats. Wenn Sie eine öffentliche URL übergeben, lädt der Server die Datei beim Anlegen des Jobs selbst herunter (bis zu 50 MB innerhalb von 30 Sekunden; Weiterleitungen werden nicht verfolgt, verwenden Sie also den endgültigen Dateilink); für private Dateien verwenden Sie stattdessen einen Direkt-Upload und übergeben sourceKey (siehe Leitfaden „Dateien und Uploads“). Fügen Sie den Header Idempotency-Key hinzu, damit eine wiederholte Anfrage nie einen zweiten Job erzeugt.

curl -X POST 'https://maxscanner.app/api/v1/jobs/' \
  -H "Authorization: Bearer $MAXSCANNER_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: quickstart-0001' \
  -d '{ "url": "https://example.com/report.docx", "filename": "report.docx", "format": "pdf" }'

Auf das Ergebnis warten

Jobs laufen asynchron, damit große Dateien Ihre HTTP-Verbindung nie offen halten. Fragen Sie die Status-URL ab – zunächst etwa alle 2 Sekunden, dann mit wachsendem Abstand bis zu 10 Sekunden. Eine kleine Office-Datei ist meist in unter 20 Sekunden fertig; ein 1080p-Video kann Minuten dauern. Sobald status completed ist, enthält output den Content-Type, die Größe in Bytes und eine signierte downloadUrl.

curl 'https://maxscanner.app/api/v1/jobs/6f0c2a6e-8a1b-4a53-9a0e-2b1f4c9d7e11/' \
  -H "Authorization: Bearer $MAXSCANNER_API_KEY"

Wie es weitergeht

Ersetzen Sie Polling durch einen Webhook, sobald Sie mehr als eine Handvoll Dateien verarbeiten, lesen Sie im Jobs-Leitfaden die Regeln für Wiederholungen nach und wählen Sie den Funktionsleitfaden, der zu Ihrer Aufgabe passt: OCR, PDF-Tools, Bilder, Medien oder das Ausführen eines gespeicherten Workflows.

Häufige Fragen

Muss ich ein SDK installieren?

Nein. Die API basiert auf einfachem HTTPS und JSON, daher funktioniert jede Sprache und jedes No-Code-Tool, das HTTP-Anfragen senden kann. Der Leitfaden mit Codebeispielen enthält vollständige Versionen für Node.js, Python, PHP und cURL.

Wie lange ist ein Download-Link gültig?

Fünf Minuten. Ist er abgelaufen, fragen Sie den Job-Status erneut ab, um einen neuen Link zu erhalten.

Gibt es einen Testmodus?

Nutzen Sie zum Testen den Free-Tarif: Er bietet dieselben Endpunkte und begrenzt jedes Konto auf 10 Anfragen pro Tag und 100 pro Monat.

Verwandte Anleitungen