PDFs kostenlos prüfen
Menü
API & Integration

Die API für barrierefreie PDFs

Die REST-API von Accessful prüft und korrigiert PDFs nach PDF/UA-2 direkt aus Ihren Systemen heraus: Dokumente übergeben, Status verfolgen, Ergebnis abrufen – asynchron, mit Webhooks und Stapelverarbeitung tausender Dokumente.

API-Dokumentation öffnen Demo buchen
REST-API

Sechs Endpunkte für den gesamten Dokument-Lebenszyklus

Upload, Statusabfrage, Download und Löschung – mehr braucht die Integration nicht. Basis-URL: https://api.accessful.de/api/v1/upload-service. Jede Anfrage wird über den Header X-API-Key authentifiziert.

Methode Pfad Zweck
POST /pdf/upload PDF-Datei hochladen und Verarbeitung starten
POST /pdf/upload-by-url-list Mehrere Dokumente per URL-Liste übergeben
GET /job-status/{caseId} Verarbeitungsstatus eines Vorgangs abfragen
GET /download/{caseId} Korrigiertes PDF herunterladen
DELETE /delete/{caseId} Einzelnes Dokument löschen
DELETE /delete Mehrere Dokumente in einem Aufruf löschen (Batch)
Ablauf

So integrieren Sie Accessful in vier Schritten

  1. Dokumente übergeben

    Senden Sie einzelne PDFs an POST /pdf/upload oder ganze Bestände per POST /pdf/upload-by-url-list – Sie erhalten je Dokument eine caseId.

  2. Asynchron verarbeiten

    Die Verarbeitung läuft asynchron. Fragen Sie den Fortschritt über GET /job-status/{caseId} ab oder lassen Sie sich per Webhook benachrichtigen.

  3. Ergebnis abrufen

    Sobald der Status „completed“ lautet, laden Sie das nach PDF/UA-2 korrigierte Dokument über GET /download/{caseId} herunter.

  4. Daten löschen

    Löschen Sie Dokumente nach der Verarbeitung einzeln über DELETE /delete/{caseId} oder gesammelt per Batch-Aufruf – Sie behalten die Datenhoheit.

Webhooks

Ihr System bleibt automatisch informiert

Statt den Status abzufragen, lassen Sie sich benachrichtigen: Accessful sendet zu jedem Statuswechsel ein Webhook-Event an Ihre Endpunkt-URL – signiert, wiederholt bei Fehlern und eindeutig identifizierbar.

Die sechs Events

  • case.queued Dokument angenommen und in der Warteschlange – inklusive Position und geschätzter Wartezeit
  • case.running Verarbeitung läuft
  • case.completed Ergebnis steht zum Download bereit
  • case.failed Verarbeitung fehlgeschlagen
  • case.canceled Vorgang abgebrochen
  • case.quota_exceeded Kontingent überschritten

Zuverlässigkeit eingebaut

  • HMAC-SHA256-Signatur im Header X-Accessful-Signature (Format t=<unix>,v1=<hex>)
  • Bis zu 10 automatische Wiederholungen mit exponentiellem Backoff
  • Idempotenz über den Header X-Accessful-Event-Id – doppelte Zustellungen sicher erkennbar

Beispiel einer Zustellung

X-Accessful-Event-Id: 9f2c81d4…
X-Accessful-Signature: t=1760082300,v1=5f8a3c…

{
  "id": "9f2c81d4…",
  "type": "case.completed",
  "apiVersion": "2026-06-26",
  "occurredAt": "2026-07-10T09:41:27Z",
  "data": {
    "caseId": "b7f3…",
    "fileName": "jahresbericht.pdf",
    "jobStatus": "completed"
  }
}

Bei case.queued enthält data zusätzlich queuePosition, queueTotal und estimatedWaitSeconds.

Einsatz in Ihren Systemen

Typische Integrationsszenarien

  • DMS / ECM

    Neu abgelegte Dokumente werden automatisch geprüft und korrigiert – barrierefrei, bevor sie jemand anfordert oder weiterverteilt.

  • CRM

    Angebote, Policen und Kundenanschreiben aus Ihrem CRM werden vor dem Versand automatisch nach PDF/UA-2 geprüft und korrigiert – ohne zusätzlichen Arbeitsschritt im Vertrieb.

  • Vertragsmanagement

    Verträge und Anlagen werden vor Versand oder Veröffentlichung nach PDF/UA-2 aufbereitet – mit revisionssicherem Prüfprotokoll als Nachweis.

  • Archivsysteme

    Bestandsdokumente rüsten Sie per URL-Liste stapelweise nach: tausende Archiv-PDFs in einem Durchlauf, ohne manuelles Hochladen.

  • Webportale

    PDFs, die Besucher in Ihrem Portal herunterladen, durchlaufen vorab die automatische Prüfung und Korrektur nach PDF/UA-2: Upload beim Publizieren, Auslieferung nach Abschluss der Korrektur.

  • Batch-Prozesse

    Nächtliche Jobs übergeben ganze Dokumentbestände; Webhooks melden jeden Statuswechsel an Ihr System – ganz ohne Polling.

KI-Agenten

Accessful für KI-Agenten

Wenn KI-Agenten Ihre Dokumentprozesse steuern, sollen sie Accessful direkt nutzen können. Dafür stellt Accessful einen Agent-Skill zum Download bereit, mit dem Agenten die API ansteuern – vom Upload bis zum Abruf des korrigierten Ergebnisses.

Agent-Skill ansehen
Dokumentation

Alles Weitere steht in der Entwickler-Dokumentation

  • Quickstart

    Der schnellste Weg zum ersten API-Aufruf: Authentifizierung, Upload und Statusabfrage Schritt für Schritt.

    Quickstart öffnen

  • Webhooks

    Alle sechs Events, Signaturprüfung und Wiederholungsverhalten im Detail erklärt.

    Webhooks-Dokumentation öffnen

  • API-Referenz

    Alle Endpunkte mit Parametern und Antworten zum Nachschlagen – für die Implementierung im Detail.

    API-Referenz öffnen

Technische Fragen zur API

Wie authentifiziere ich Anfragen an die Accessful-API?

Jede Anfrage trägt Ihren API-Schlüssel im HTTP-Header X-API-Key. Wie Sie den Schlüssel einbinden und den ersten Aufruf absetzen, zeigt der Quickstart in der API-Dokumentation.

Arbeitet die API synchron oder asynchron?

Asynchron: Der Upload liefert eine caseId zurück. Den Fortschritt fragen Sie über GET /job-status/{caseId} ab – oder Sie lassen sich per Webhook über jeden Statuswechsel informieren, von case.queued bis case.completed.

Kann ich hochgeladene Dokumente über die API wieder löschen?

Ja. Einzelne Dokumente löschen Sie über DELETE /delete/{caseId}, mehrere gesammelt über den Batch-Endpunkt DELETE /delete. So bleibt die Datenhaltung vollständig in Ihrer Hand.

Woran erkenne ich, dass ein Webhook wirklich von Accessful stammt?

Jede Zustellung ist per HMAC-SHA256 signiert: Der Header X-Accessful-Signature enthält Zeitstempel und Signatur im Format t=<unix>,v1=<hex>. Damit prüfen Sie Herkunft und Unversehrtheit jeder Nachricht – Details in der Webhooks-Dokumentation.

Starten Sie mit dem ersten API-Aufruf.

Die Dokumentation führt Sie vom API-Schlüssel bis zum ersten korrigierten PDF. Oder besprechen Sie Ihre Integrationsarchitektur direkt mit uns.

API-Dokumentation öffnen Demo buchen