EqualDoc EqualDoc testen

API

EqualDoc API

Binden Sie die PDF-Barrierefreiheit von EqualDoc in Ihre eigenen Abläufe ein: für einzelne Dokumente ebenso wie für große Dokumentbestände.

Entwurf. Die EqualDoc API ist in Planung und noch nicht öffentlich verfügbar. Diese Seite zeigt das vorgesehene Konzept; Endpunkte, Felder und Antworten können sich bis zum Start ändern.

Wofür die API gedacht ist

Die API richtet sich an Organisationen, die PDFs nicht einzeln im Browser, sondern automatisiert verarbeiten möchten.

Dokumente aus Ihrem Dokumentenmanagement, Ihrem Redaktionssystem oder Ihren Fachverfahren werden an EqualDoc übergeben, aufbereitet und mit Prüfbericht zurückgegeben, ohne manuellen Zwischenschritt.

  • Einzelne PDFs bei Bedarf verarbeiten
  • Große Dokumentmengen in Stapeln verarbeiten
  • In bestehende Abläufe und Systeme integrieren
  • Aufbereitetes PDF und Prüfbericht abrufen

So läuft eine Verarbeitung ab

Jedes Dokument durchläuft vier Schritte. Die Verarbeitung läuft asynchron: Sie starten sie und fragen den Status ab, bis das Ergebnis bereitsteht.

  1. PDF hochladen

    Sie übertragen das Dokument und erhalten eine Dokument-ID.

    POST /v1/documents

  2. Verarbeitung starten

    EqualDoc analysiert das Dokument, bereitet es auf und validiert das Ergebnis.

    POST /v1/documents/{id}/convert

  3. Status abfragen

    Der Status zeigt, ob das Dokument wartet, verarbeitet wird oder fertig ist.

    GET /v1/documents/{id}

  4. Ergebnis abrufen

    Sie laden das aufbereitete PDF und den Prüfbericht herunter.

    GET /v1/documents/{id}/result

Endpunkte (Entwurf)

Eine erste Übersicht der vorgesehenen Endpunkte.

Entwurf, kein verbindlicher API-Vertrag. Pfade, Parameter und Antworten werden bis zum Start festgelegt und dann vollständig dokumentiert.

POST /v1/documents
PDF hochladen und Dokument anlegen
POST /v1/documents/{id}/convert
Aufbereitung starten
GET /v1/documents/{id}
Status und Metadaten abfragen
GET /v1/documents/{id}/result
Aufbereitetes PDF und Prüfbericht abrufen
DELETE /v1/documents/{id}
Dokument und Ergebnisse löschen

Beispiel: ein Dokument verarbeiten

So könnte eine Verarbeitung mit curl aussehen. Adresse, Dokument-ID und Schlüssel sind Platzhalter.

Anfrage: PDF hochladen und Verarbeitung starten
curl -X POST https://api.equaldoc.example/v1/documents \
  -H "Authorization: Bearer $EQUALDOC_API_KEY" \
  -F "file=@jahresbericht-2026.pdf"

curl -X POST https://api.equaldoc.example/v1/documents/doc_7f3a9c/convert \
  -H "Authorization: Bearer $EQUALDOC_API_KEY"
Antwort: Status abfragen (GET /v1/documents/doc_7f3a9c)
{
  "id": "doc_7f3a9c",
  "status": "completed",
  "pages": 24,
  "created_at": "2026-10-05T09:12:04Z",
  "result": "/v1/documents/doc_7f3a9c/result"
}

Vorgesehene Status: queued, processing, completed, failed.

Zugang und Stapelverarbeitung

API-Schlüssel

Der Zugriff erfolgt später über API-Schlüssel, die Sie in Ihrem Konto erstellen und widerrufen können. Jede Anfrage überträgt den Schlüssel als Bearer-Token. API-Schlüssel können derzeit noch nicht erstellt werden.

Stapelverarbeitung und Integrationen

Stapelverarbeitung und automatisierte Integrationen sind Teil des Produktkonzepts: viele Dokumente in einem Auftrag übergeben und die Ergebnisse gesammelt abrufen. Eine Benachrichtigung bei Abschluss, etwa per Webhook, ist vorgesehen.

Sie möchten EqualDoc in Ihre Abläufe einbinden?

Erzählen Sie uns, welche Dokumente und Systeme Sie verbinden möchten. Wir melden uns, sobald der Zugang zur API möglich ist.

Kontakt aufnehmen Produkt im Überblick