API-Dokumentation

Schnellstart

In drei Schritten vom Start zum ersten Aufruf.

1. Test-Schlüssel anlegen

   Melden Sie sich an (kostenlos, nur ein Code per E-Mail) und legen Sie im Konto unter „API-Schlüssel“ einen Schlüssel an. Wählen Sie einen Test-Schlüssel: Er ist kostenlos, auf 20 Aufrufe pro Tag und Dateien bis 5 MB begrenzt.

   API-Schlüssel öffnen

2. Schlüssel ablegen

   Legen Sie den Schlüssel in einer Umgebungsvariable ab, statt ihn in den Code zu schreiben:

   export OWT_KEY=owk_test_...

3. Aufruf bauen und ausführen

   Wählen Sie unten ein Werkzeug, kopieren Sie den Aufruf und führen Sie ihn aus. Das Ergebnis ist die bearbeitete Datei (bei Prüf-Werkzeugen ein JSON-Bericht).

curl -X POST 'https://wandlix.com/api/v1/tools/merge-pdf' \
  -H "Authorization: Bearer $OWT_KEY" \
  -F 'files=@file1.pdf' \
  -F 'files=@file2.pdf' \
  -OJ

Zugang

Erstellen Sie in Ihrem Konto einen API-Schlüssel und senden Sie ihn bei jedem Aufruf im Kopf Authorization mit. Zum Konto

Authorization: Bearer owk_YOUR_KEY

Ein ungültiger oder gesperrter Schlüssel wird abgewiesen (HTTP 401) – nie als Gast behandelt. Schlüssel gehören nicht in öffentlichen Code, Browser-Programme oder Repositories.

Test-Schlüssel

Schlüssel, die mit owk_test_ beginnen, sind kostenlos und berühren Ihr Guthaben nicht. Sie eignen sich zum Ausprobieren der Anbindung und sind begrenzt auf 20 Aufrufe pro Tag und Dateien bis 5 MB. Danach kommt HTTP 402 (quota_exceeded).

Pro Schlüssel lässt sich im Konto ein eigenes Limit für Anfragen pro Minute festlegen; es ersetzt dann das Limit je IP-Adresse.

Aufruf

Eine Anfrage pro Durchgang, als multipart/form-data. Dateien liegen nur im Arbeitsspeicher und werden nach der Antwort verworfen.

POST https://wandlix.com/api/v1/tools/<tool>
Content-Type: multipart/form-data

• files – eine oder mehrere Dateien; die Reihenfolge ist die Verarbeitungsreihenfolge
• options – optional, JSON-Text mit den Optionen des Werkzeugs (siehe Tabelle unten)

Werkzeuge ohne Dateien (zum Beispiel qr-code und create-einvoice) nehmen auch Content-Type: application/json mit dem Inhalt {"options": {…}} an. Das hilft bei Programmen, die keine Formular-Uploads senden können, etwa Online-Curl-Diensten.

curl

curl -X POST "https://wandlix.com/api/v1/tools/merge-pdf" \
  -H "Authorization: Bearer $OWT_KEY" \
  -F "files=@a.pdf" -F "files=@b.pdf" \
  -o merged.pdf

curl -X POST "https://wandlix.com/api/v1/tools/compress-image" \
  -H "Authorization: Bearer $OWT_KEY" \
  -F "files=@photo.png" \
  -F 'options={"quality":70,"maxWidth":1600}' \
  -o photo-small.png

JavaScript (Node.js)

const form = new FormData();
form.append("files", new Blob([await fs.readFile("a.pdf")]), "a.pdf");
form.append("files", new Blob([await fs.readFile("b.pdf")]), "b.pdf");

const res = await fetch("https://wandlix.com/api/v1/tools/merge-pdf", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.OWT_KEY },
  body: form,
});
if (!res.ok) throw new Error((await res.json()).error);
await fs.writeFile("merged.pdf", Buffer.from(await res.arrayBuffer()));

Python

import os, requests

res = requests.post(
    "https://wandlix.com/api/v1/tools/merge-pdf",
    headers={"Authorization": "Bearer " + os.environ["OWT_KEY"]},
    files=[("files", open("a.pdf", "rb")), ("files", open("b.pdf", "rb"))],
)
res.raise_for_status()
open("merged.pdf", "wb").write(res.content)

PHP

$ch = curl_init("https://wandlix.com/api/v1/tools/merge-pdf");
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("OWT_KEY")],
    CURLOPT_POSTFIELDS => [
        "files[0]" => new CURLFile("a.pdf"),
        "files[1]" => new CURLFile("b.pdf"),
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
file_put_contents("merged.pdf", curl_exec($ch));

Antwort

Bei Erfolg (HTTP 200) kommt die Ergebnisdatei zurück, bei mehreren Ergebnisdateien ein ZIP. Dateiname im Kopf Content-Disposition, Zusatzangaben im Kopf X-Result-Info (URL-kodiertes JSON).

Die E-Rechnung-Prüfung liefert stattdessen JSON mit dem Prüfbericht unter result.

Werkzeuge und Optionen

Die Kennung des Werkzeugs gehört in die Adresse. Optionen, die Sie weglassen, nehmen den Standardwert.

Verbrauch und Grenzen

Jeder Aufruf wird Ihrem Konto belastet – wie auf der Webseite.

• Zuerst gilt das tägliche Gratis-Kontingent Ihres Kontos.
• Danach werden Credits abgebucht (zuerst die Gratis-Credits des Monats, dann gekaufte). Die Kosten je Werkzeug stehen im Konto.
• Fehlgeschlagene Aufrufe kosten nichts.
• Höchstens 15 Anfragen pro Minute und IP-Adresse; bei Überschreitung kommt HTTP 429.

Fehler

Fehler kommen als JSON mit dem Feld error und dem passenden HTTP-Status.

HTTP 402
{"error":"quota_exceeded"}

Datenschutz

Die API arbeitet genau wie die Webseite: Verarbeitung in Deutschland, Dateien nur im Arbeitsspeicher, Löschung spätestens nach einer Stunde, keine Protokollierung von Dateinamen oder Inhalten.