API

API-Konzepte

Verstehen Sie Authentifizierung, asynchrone Tasks und den Lebenszyklus der Dokumentkonvertierungs-API.

Die Inkora API ist REST-basiert, verwendet JSON für Requests und Responses und authentifiziert jede Anfrage mit einem Bearer API-Schlüssel.

Basis-URL und Authentifizierung

Alle Endpunkte sind unter https://fusion-api.oomol.com/v1 verfügbar. Senden Sie den API-Schlüssel im Request-Header Authorization.

text

Authorization: Bearer YOUR_API_KEY

Geben Sie diesen Schlüssel nicht in Frontend-Code preis. Leiten Sie browserseitige Konvertierungen über Ihr eigenes Backend weiter.

Asynchroner Task-Lebenszyklus

Die Dokumentkonvertierung ist asynchron. Ein Submit-Endpunkt liefert sessionID, also die Task-ID; der zugehörige Ergebnis-Endpunkt meldet einen dieser Status:

processing: Die Datei wartet oder wird konvertiert.
completed: Das Ergebnis enthält die erzeugte Ausgabe-URL in data.downloadURL und Metadaten.
failed: Das Ergebnis enthält einen Fehlergrund, den Ihre Anwendung anzeigen oder protokollieren sollte.

Ihre Integration sollte beim Erreichen eines Endstatus das Abfragen beenden, begrenzte Wiederholungen nutzen und die Task-ID für Support und Wiederherstellung aufbewahren.

Endpunkte

Die API unterstützt derzeit PDF-zu-Markdown und PDF-zu-EPUB. Die vollständige API-Referenz enthält Endpunktpfade, Parameter, Beispiel-Payloads sowie Hinweise zu Python- und TypeScript-SDKs.