Dokumentation

Der Integrationsvertrag

Vom API-Key zum PDF/UA in drei klaren Schritten

Eine Basis-URL, ein Authentifizierungs-Header und eine Case-ID verbinden den gesamten Ablauf.

1. 01POST/pdf/upload

   Hochladen

   Sende ein oder mehrere PDFs und erhalte für jede akzeptierte Datei eine caseId.

   Endpunkt-Dokumentation öffnen
2. 02GET/job-status/{caseId}

   Verfolgen

   Verfolge den klaren Lifecycle von queued über running bis zum Endstatus.

   Endpunkt-Dokumentation öffnen
3. 03GET/download/{caseId}

   Herunterladen

   Lade das überarbeitete Dokument als normale application/pdf-Antwort herunter.

   Endpunkt-Dokumentation öffnen

Kopieren, starten, integrieren

Dein erster Upload ist startklar

Wähle deinen Stack. Jedes Beispiel nutzt denselben Endpunkt und liefert die Case-ID für alle weiteren API-Aufrufe.

• ACCESSFUL_API_KEY setzen
• document.pdf im Arbeitsverzeichnis ablegen
• Beispiel starten und successfulUploads[0] übernehmen

Mit dem vollständigen Quickstart weitermachen

first-upload API

cURLNode.jsPython

: "${ACCESSFUL_API_KEY:?Set ACCESSFUL_API_KEY first}"

curl --fail-with-body \
  -X POST "https://api.accessful.de/api/v1/upload-service/pdf/upload" \
  -H "X-API-Key: $ACCESSFUL_API_KEY" \
  -F "files=@document.pdf"

import { openAsBlob } from 'node:fs';

const apiKey = process.env.ACCESSFUL_API_KEY;
if (!apiKey) throw new Error('Set ACCESSFUL_API_KEY first');

const file = await openAsBlob('document.pdf', {
  type: 'application/pdf',
});
const body = new FormData();
body.append('files', file, 'document.pdf');

const response = await fetch(
  'https://api.accessful.de/api/v1/upload-service/pdf/upload',
  {
    method: 'POST',
    headers: { 'X-API-Key': apiKey },
    body,
  },
);

if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

# pip install requests
import os
import requests

url = "https://api.accessful.de/api/v1/upload-service/pdf/upload"
headers = {"X-API-Key": os.environ["ACCESSFUL_API_KEY"]}

with open("document.pdf", "rb") as pdf:
    response = requests.post(
        url,
        headers=headers,
        files={"files": ("document.pdf", pdf, "application/pdf")},
        timeout=60,
    )

response.raise_for_status()
print(response.json())

200 OKsuccessfulUploads[0] → caseId

Wähle deinen nächsten Schritt

Von der ersten Anfrage bis zur Produktion – ohne Suchen

Jeder Einstieg beginnt genau dort, wo du bist, und führt direkt zum benötigten Detail.

Quickstart

Upload → Status → Download vollständig ausführen.

Quickstart öffnen

Live API-Tester

Konvertiere im Browser mit deinem eigenen Key ein echtes PDF.

Live testen

API-Referenz

Prüfe jeden Endpunkt, jedes Feld und jeden Statuscode.

Endpunkte ansehen

Webhooks

Ersetze Polling durch signierte, ereignisgesteuerte Callbacks.

Webhooks einrichten

Bereit für Agents

Du entwickelst mit einem KI-Coding-Agent?

Installiere den versionierten Accessful-Skill, damit dein Agent den vollständigen API-Vertrag ohne Rätselraten versteht.

Agent-Skill herunterladen