API-Dokumentation

Überblick

Mit der Orbitex-API binden Sie Komprimieren, Zusammenfügen, Teilen und Umwandeln in eigene Anwendungen, Skripte und CI-Pipelines ein. Alle Anfragen laufen über HTTPS und benötigen einen API-Schlüssel.

Die API ist in Entwicklung. Endpunkte, Ratenbegrenzungen und Details zur Authentifizierung werden hier vor der öffentlichen Beta veröffentlicht.

Authentifizierung

Anfragen enthalten einen Authorization-Header mit Ihrem API-Schlüssel:

• Schlüssel erstellen Sie in Ihrem Orbitex-Dashboard (Business-Tarif).
• Tauschen Sie einen Schlüssel im Dashboard aus, wenn er kompromittiert wurde.
• Geben Sie Schlüssel nie in clientseitigem JavaScript oder öffentlichen Repositories preis.

Geplante Endpunkte

Der erste Umfang der API wird enthalten:

• POST /v1/pdf/compress - PDF-Dateigröße verringern
• POST /v1/pdf/merge - Mehrere PDFs verbinden
• POST /v1/pdf/split - Nach Seiten oder Bereichen teilen
• POST /v1/pdf/convert - PDF in Word, Excel und zurück
• POST /v1/pdf/protect - Mit einem Passwort verschlüsseln
• GET /v1/jobs/{id} - Status eines asynchronen Auftrags abfragen

Umgang mit Dateien

Für hochgeladene Dateien gelten dieselben Sicherheits- und Löschregeln wie in der Weboberfläche. Aufbewahrungsfristen und Details zur Verschlüsselung stehen in der Richtlinie zur Dateisicherheit.

Webhooks benachrichtigen Ihren Server, wenn lang laufende Aufträge fertig sind.

Ratenbegrenzungen

Die Ratenbegrenzungen hängen vom Tarif ab. Ein API-Zugang im kostenlosen Tarif ist nicht geplant. Business-Kunden erhalten dokumentierte Grenzen und Spielraum für Lastspitzen.

Frühen Zugang erhalten

Erzählen Sie uns von Ihrem Anwendungsfall - Umwandlung im Stapel, Dokument-Pipelines, SaaS-Integration - und wir melden uns, sobald die Beta öffnet.