Plattformübersicht
Die OmniDoc API unterstützt Datei- und Inhaltsworkflows innerhalb eines einzigen Kontos. Ein Aufrufer erstellt Ressourcen mit einem API-Schlüssel und verwendet anschließend die zurückgegebenen stabilen IDs, um diese abzufragen, zu kombinieren, zu verarbeiten oder herunterzuladen.
Ressourcenmodell
Abschnitt betitelt „Ressourcenmodell“| Ressource | Zweck |
|---|---|
| Dokument / Datei | Quelldateien und Dateibibliothekseinträge, die dem Konto gehören |
| Job / Operation | Asynchrone Übersetzungs-, Dokumentenverarbeitungs- oder Audio-/Video-Jobs |
| Artifact | Ergebnisse, die ein Auftrag für die Vorschau oder den Download liefert |
| Kreditoperation | Die Aufzeichnung darüber, welche abrechenbare Maßnahme abgerechnet und erstattet wurde |
Jede Ressource wird mit dem zugehörigen Konto abgeglichen. Clients müssen lediglich öffentliche IDs beibehalten und dürfen keine Implementierungsdetails aus IDs, Dateinamen oder Download-Adressen ableiten.
Üblicher Anrufablauf
Abschnitt betitelt „Üblicher Anrufablauf“- Erstellen oder wählen Sie eine Eingaberessource.
- Stellen Sie sicher, dass das Konto über Guthaben verfügt: Der Kontostand wird vor Beginn des Jobs mit einem Schwellenwert verglichen, und die tatsächliche Nutzung wird nach Abschluss abgerechnet.
- Erstellen Sie den Job mit einem
Idempotency-Key. - Überprüfen Sie den Auftragsstatus; Dateiübersetzungsjobs können auch SSE oder Webhooks verwenden.
- Lesen Sie die Ergebnisse und den Kreditprotokoll für diesen Auftrag.
Identität
Abschnitt betitelt „Identität“Externe Integrationen verwenden stets API-Schlüssel mit denselben Berechtigungen wie das Konto, das den Schlüssel erstellt hat. Siehe Authentifizierung .
Schnellstart → Laden Sie eine Datei hoch, erstellen Sie einen Auftrag, prüfen Sie dessen Status und laden Sie die Ergebnisse herunter.