Seminar Stirling PDF API und Integration

Inhaltsverzeichnis

• Abstract
• Zielbild und Nutzen
• Zielgruppe
• Voraussetzungen
• Inhalte und Agenda
• Praxis
• Ergebnisse und Transfer

Abstract

Das Seminar vermittelt die Integration von Stirling PDF in Skripte, Jobs und Anwendungen über die REST-API. Behandelt werden API-Dokumentation (Swagger), Authentifizierung per API-Key, typische Endpunkte (Konvertierung, OCR, Komprimierung, Security) sowie robuste Patterns für Multipart-Uploads, Fehlerbehandlung und Skalierung. Ziel ist eine produktionsnahe API-Nutzung mit stabilen Integrationsabläufen.

Zielbild und Nutzen

• Standardisierte API-Aufrufe für wiederkehrende Prozesse
• Weniger manuelle Bearbeitung durch automatisierte Jobs
• Robuste Integrationen durch konsistente Fehler- und Retry-Strategien

Zielgruppe

• Softwareentwicklung, DevOps, Integrations-Teams
• Automation-Teams (Skripting, RPA-Umfeld)
• IT-Teams mit Schnittstellenverantwortung

Voraussetzungen

• Grundkenntnisse HTTP/REST
• Scripting-Grundlagen (z. B. curl-Denke) oder Programmiersprache
• Optional: Testinstanz verfügbar

Inhalte und Agenda

• Tag 1: API-Grundlagen und sichere Requests
  • API-Dokumentation: Lokale Swagger-UI (/swagger-ui/index.html)
  • Authentifizierung
    • Nutzerbezogene API-Keys
    • Globaler API-Key (Konfiguration)
    • Header-Handling (X-API-KEY)
  • Request-Modelle
    • Multipart-Form-Data Uploads
    • Parameterübergabe und Output-Dateien
  • Basis-Endpunkte: Convert, Compress, OCR, Compare (Anwendungslogik)
• Tag 2: Produktionsmuster und Integration
  • Fehlerhandling
    • 4xx vs 5xx
    • Validierungsfehler, Timeouts, Payload-Limits
  • Batch- und Job-Patterns
    • Queue-Ansätze, Parallelität, Rate-Limits
    • Idempotenz-Design (wo möglich)
  • Security und Governance
    • API nur intern, Reverse-Proxy-Konzept, CORS-Grundsätze
    • Endpoints selektiv deaktivieren (Hardening)
  • Monitoring
    • Health-/Status-Endpunkte
    • Request-Zähler- und Nutzungsendpunkte (je nach Lizenz/Edition)

Praxis

• Minimaler API-Workflow (Convert)
  • API-Doku in Swagger öffnen, Endpunkt auswählen
  • Request mit Multipart-Upload aufbauen (Datei + Parameter)
  • Auth-Header setzen (X-API-KEY)
  • Response speichern, Output validieren (Dateiformat, Seitenzahl)
• OCR per API und Folgeprozess
  • OCR-Endpunkt mit Parametern aufrufen (Sprachen, Deskew/Clean)
  • Output prüfen: Suche und Textlayer
  • Optional: OCR-Output in Konvertierungskette weiterreichen
• Robustes Fehlerhandling
  • Fehler provozieren (fehlender Parameter, falscher Content-Type)
  • Fehlerklassifikation dokumentieren
  • Retry-Regel ableiten (wann retry sinnvoll, wann nicht)
  • Logging-Standard festlegen (Request-ID, Timestamp, Endpoint, Dauer)
• Batch-Pattern
  • Mehrere Dateien per Schleife verarbeiten
  • Parallelität begrenzen (z. B. N gleichzeitige Requests)
  • Ergebnisaggregation: Erfolg/Fehler, Summen, Laufzeit

Ergebnisse und Transfer

• API-Request-Kochbuch (Request-Templates + Parameterbeispiele)
• Fehlerkatalog und Retry-Matrix
• Referenz-Integration: Batch-Runner (Skript-Blueprint)