API-Dokumentation

Integrieren Sie DocPort direkt in Ihre Anwendung. Konvertieren Sie Apple-Dokumente automatisiert per REST-API.

Authentifizierung

Alle API-Endpunkte erfordern einen API-Key im X-API-Key Header.

Beispiel:

curl -X POST https://docport.juergenkoller.software/api/v1/convert \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@document.pages" \
  -F "output_format=docx"

Unterstützte Formate

Endpunkte

Datei konvertieren

POST /api/v1/convert

Konvertiert eine Apple-Datei in das gewünschte Ausgabeformat.

Parameters (multipart/form-data):

• file — Die zu konvertierende Datei (.pages, .numbers, .key)
• output_format — Zielformat (optional, Standard: automatisch)

Response:

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "queued",
  "status_url": "/api/v1/jobs/550e8400-e29b-41d4-a716-446655440000"
}

Job-Status abfragen

GET /api/v1/jobs/{job_id}

Gibt den aktuellen Status einer Konvertierung zurück.

Status-Werte: queued, processing, completed, failed

Response:

{
  "job_id": "550e8400-...",
  "status": "completed",
  "filename": "document.pages",
  "output_format": "docx",
  "created_at": "2026-02-26T12:00:00Z",
  "completed_at": "2026-02-26T12:00:05Z",
  "download_url": "/api/v1/jobs/550e8400-.../download"
}

Ergebnis herunterladen

GET /api/v1/jobs/{job_id}/download

Lädt die konvertierte Datei herunter (nur bei Status completed).

Batch-Konvertierung

POST /api/v1/batch

Konvertiert bis zu 100 Dateien in einem Aufruf.

Beispiel:

curl -X POST https://docport.juergenkoller.software/api/v1/batch \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "files=@doc1.pages" \
  -F "files=@doc2.numbers" \
  -F "files=@presentation.key"

Batch-Status abfragen

GET /api/v1/batch/{batch_id}

Batch als ZIP herunterladen

GET /api/v1/batch/{batch_id}/download

Limits

• Max. Dateigröße: 100 MB pro Datei
• Rate-Limit: 100 Anfragen/Minute (Einzelkonvertierung)
• Rate-Limit: 10 Anfragen/Minute (Batch)
• Max. Batch-Größe: 100 Dateien
• Dateien werden nach 24 Stunden automatisch gelöscht