Die Korrektur-Pipeline als API.

Die gleiche Korrektur, die die a11yfy-Web-App durchführt, ist über einfache REST-Schnittstellen verfügbar: Laden Sie eine PDF-Datei hoch und erhalten Sie ein mit PDF/UA-1 getaggtes, validiertes Dokument zurück – in einem einzigen Aufruf, aus jeder Sprache oder jedem Stack.

So lässt es sich in Ihren Stack integrieren

  • Beim Hochladen – Korrigieren Sie Dokumente in dem Moment, in dem Ihre Nutzer oder Systeme sie veröffentlichen.
  • Im Batch-Verfahren – Bearbeiten Sie einen Rückstand Ordner für Ordner, bei gleicher Abrechnung pro Seite.
  • In Ihrem Produkt – Stellen Sie Ihren eigenen Nutzern über Ihre eigene Benutzeroberfläche dieselbe PDF/UA-1-Ausgabe und denselben Bericht auf Problemebene bereit.

Der Ablauf

  1. POST /v1/jobs – Senden Sie ein PDF als Multipart-Datei, optional mit einer webhook_url. Sie erhalten umgehend eine job_id zurück. Der Server führt dann automatisch die gesamte Pipeline durch – Diagnose, Tagging oder vollständige Rekonstruktion, anschließend Validierung – und belastet die für das Dokument erforderlichen Credits.
  2. Status verfolgen – GET /v1/jobs/{id} abfragen oder, falls Sie eine webhook_url angegeben haben, eine signierte Benachrichtigung erhalten, sobald der Auftrag einen Endzustand erreicht.
  3. GET /v1/jobs/{id}/result – Laden Sie die mit PDF/UA-1 getaggte Ausgabe und den dazugehörigen Validierungsbericht auf Issue-Ebene herunter.

Nutzen Sie für die Einbindung in Ihr eigenes Abrechnungs- und Überwachungssystem die Endpunkte GET /v1/balance (Guthaben) und GET /v1/usage (Nutzung).

Offizielle SDKs: Python und npm

Wenn Sie HTTP-Aufrufe nicht von Hand schreiben möchten, nutzen Sie die offiziellen Client-Bibliotheken – beide sind schlanke, typisierte Wrapper um die oben beschriebene v1-API:

Beide SDKs sind Open Source: github.com/a11yfy/sdk.

Warum es in Ihr eigenes System integrieren?

  • Sprachunabhängiges REST. Kein SDK erforderlich: ein HTTP-Aufruf aus beliebiger Sprache – senden Sie die Datei als multipart/form-data.
  • Asynchron, mit Webhooks. Kein Polling erforderlich: Ihr eigener Workflow wird durch den Endzustand ausgelöst, und die Benachrichtigung ist kryptografisch signiert.
  • Idempotente Übermittlung. Das versehentliche erneute Senden derselben Datei führt niemals zu einer doppelten Abrechnung.
  • Gemeinsames Ledger. API-Schlüssel gelten teamweit; die Nutzung wird im selben Workspace-Budget wie Web-Uploads ausgewiesen.
  • Verarbeitung in der EU, automatische Löschung. Eingaben werden nach 7 Tagen gelöscht, Ausgaben nach 30 Tagen – ohne dass Sie etwas tun müssen.

Praktische Hinweise

  • Die v1-API antwortet auf Englisch; die Behandlung der Dokumentsprache (Alt-Text, Metadaten) richtet sich nach dem Dokument selbst, nicht nach der API-Spracheinstellung.
  • Die Kosten entsprechen den Web-Preisen: Technische Reparaturen und vollständige Rekonstruktionen werden pro Seite berechnet, je nach Dokumentprofil.

API-Referenz → · Preise →