veraPDF als API: PDF/UA-Prüfungen für 10 Credits

Eine PDF/UA-Prüfung kostet 10 Credits. veraPDF prüft das PDF gegen PDF/UA-1 oder PDF/UA-2, die ISO-Norm für barrierefreie PDFs, und liefert den vollständigen Bericht: ob die Datei konform ist und jede verletzte Regel mit den Objekten, die sie verletzen. Eine PDF/A-Prüfung kostet 2 Credits, eine WTPDF-Prüfung 10.

Die API ist die von veraPDF REST selbst. Ein Client für veraPDF REST behält seine Pfade und seinen Berichtsparser; er ändert die Basis-URL auf https://api.pagespool.com/v1/verapdf und sendet einen API-Schlüssel.

Was veraPDF prüft

veraPDF ist der Open-Source-PDF-Validator eines Konsortiums unter Leitung der Open Preservation Foundation und der PDF Association. Er prüft:

• PDF/UA-1 und PDF/UA-2 (ISO 14289), für Barrierefreiheit: Tags und Struktur, Alternativtext an Abbildungen, Schriften, Sprache und Metadaten;
• WTPDF 1.0, Accessibility und Reuse;
• PDF/A, die ISO-Norm für die Archivierung: die Teile 1, 2 und 3 in den Stufen a, b und u (Teil 1 hat kein u) und Teil 4 mit e und f. Das Profil auto prüft gegen den Teil, den die Datei in ihren Metadaten angibt, und gegen PDF/A-1b, wenn sie keinen angibt.

veraPDF prüft die Regeln, die eine Maschine prüfen kann. Eine bestandene PDF/UA-Prüfung heißt nicht, dass Alternativtext oder Lesereihenfolge sinnvoll sind; das muss weiterhin ein Mensch beurteilen.

Preise und Limits

Ein fehlgeschlagener Aufruf kostet nichts. Jeder Aufruf nimmt ein PDF bis 25 MB an, gesendet als Multipart-Feld file. Eine Prüfung läuft höchstens 50 Sekunden; eine längere wird mit 504 abgebrochen. Jedes Konto erhält jeden Tag und jeden Monat kostenlose Credits, und die Tarife stehen auf der Preisseite.

veraPDF selbst hosten oder hier aufrufen

veraPDF REST ist ein Java-Server. Ihn selbst zu hosten heißt eine JVM mit etwa 1 GB Arbeitsspeicher pro Instanz, die läuft und aktuell gehalten wird. Er hat keine eigene Authentifizierung, braucht also ein Gateway mit TLS und Schlüsseln davor, bevor ihn etwas außerhalb Ihres Netzwerks aufrufen darf. Eine kalte JVM braucht außerdem nach jedem Start Dutzende Sekunden für ihre ersten Prüfungen, sie muss also aufgewärmt werden, bevor sie Anfragen annimmt.

Hier ist es ein API-Schlüssel und dieselbe API. veraPDF läuft warm, eine Prüfung wird nur berechnet, wenn sie gelingt, und derselbe Schlüssel und dasselbe Credit-Guthaben gelten für die anderen Engines dieser Website.

Schnellstart mit curl

Ein PDF gegen PDF/UA-1 prüfen und das Ergebnis ausgeben:

curl -sS -H "X-API-Key: $API_KEY" -H "Accept: application/json" \
  -F file=@document.pdf \
  https://api.pagespool.com/v1/verapdf/api/validate/ua1 \
  | jq '.report.jobs[0].validationResult[0].compliant'

Accept wählt das Format des Berichts: application/xml für XML, text/html für HTML, JSON für alles andere. Die verletzten Regeln stehen in .report.jobs[0].validationResult[0].details.ruleSummaries. Eine PDF/A-Prüfung ist derselbe Aufruf mit einem PDF/A-Profil, etwa validate/2b.

Ihr Client für veraPDF REST, unverändert

Richten Sie den Client auf https://api.pagespool.com/v1/verapdf aus, wo er die Wurzel von veraPDF REST hatte, etwa http://localhost:8080. Die Pfade bleiben gleich:

• POST /api/validate/{profile} mit dem PDF als Multipart-Feld file;
• GET /api/profiles, GET /api/profiles/{id} (ids listet die Profil-IDs);
• GET /api/info.

Ein Client, der nur eine Basis-URL annimmt, trägt den Schlüssel darin: https://x:YOUR_API_KEY@ gefolgt vom API-Host und /v1/verapdf. Vier Dinge unterscheiden sich von einem eigenen Server: Eine Anfrage ohne Accept erhält JSON, wo veraPDF REST HTML liefert; /api/info lässt die eigene Adresse und den Hostnamen des Servers weg; POST /api/validate/url/{profile} und /api/sha1 werden nicht angeboten; und eine Datei, die kein PDF ist, wird vor der Prüfung mit 422 abgelehnt.

Ihr API-Schlüssel, drei Wege

Senden Sie den Schlüssel in der Form, die Ihr Client unterstützt:

• im Header X-API-Key: YOUR_API_KEY;
• im Header Authorization: Bearer YOUR_API_KEY;
• per HTTP-Basic-Authentifizierung mit dem Schlüssel als Passwort und einem beliebigen Benutzernamen; das sendet ein HTTP-Client für eine URL mit dem Schlüssel darin, https://x:YOUR_API_KEY@….

Setzen Sie den Schlüssel nie in einen Pfad oder einen Query-String: Beide landen in Protokollen. Ein Aufruf ohne gültigen Schlüssel erhält 401.

Kostenlose Tools und MCP

Testen Sie eine Prüfung im Browser, ohne Konto: die PDF-Barrierefreiheitsprüfung (PDF/UA) und den PDF/A-Validator, für PDFs bis 4 MB.

KI-Agenten erreichen veraPDF über seinen MCP-Server unter https://api.pagespool.com/mcp/verapdf/. Er hat zwei Tools: check_pdf_accessibility (PDF/UA, 10 Credits) und validate_pdfa (2 Credits), die jeweils das Ergebnis und die verletzten Regeln liefern. Unter Verbinden steht die Einrichtung für jeden Client.

Marken

veraPDF ist eine Marke ihres Inhabers; pagespool ist mit ihm nicht verbunden.

FAQ

Kann ich meinen Client für veraPDF REST behalten?

Ja. Ändern Sie seine Basis-URL auf /v1/verapdf auf dem API-Host und senden Sie Ihren API-Schlüssel. Die Pfade, die Profil-IDs, das Multipart-Feld file und der Bericht bleiben, wie veraPDF REST sie hat.

Was kostet eine Prüfung?

Eine PDF/UA- oder WTPDF-Prüfung kostet 10 Credits, eine PDF/A-Prüfung 2. Das Abrufen der Profile und der Serverinformationen ist kostenlos, und ein fehlgeschlagener Aufruf kostet nichts.

Heißt eine bestandene PDF/UA-Prüfung, dass das PDF barrierefrei ist?

Sie heißt, dass das PDF jede Regel besteht, die veraPDF maschinell prüfen kann. Ob Alternativtext und Lesereihenfolge sinnvoll sind, muss weiterhin ein Mensch beurteilen.

Wird mein PDF gespeichert?

Nein. Das PDF wird nur gehalten, solange veraPDF es prüft, und danach nicht aufbewahrt.