Platformoverzicht
De OmniDoc API ondersteunt bestands- en contentworkflows binnen één account. Een aanroeper maakt resources aan met een API-sleutel en gebruikt vervolgens de stabiele ID’s die als reactie worden teruggegeven om deze op te vragen, samen te voegen, te verwerken of te downloaden.
Resourcemodel
Section titled “Resourcemodel”| Middel | Doel |
|---|---|
| Document / Bestand | Bronbestanden en bestandsbibliotheekvermeldingen die eigendom zijn van het account |
| Taak / Bewerking | Asynchrone vertaling, documentverwerking of audio- en videoprocessen |
| Artifact | Resultaten die een taak oplevert voor voorbeeldweergave of download |
| Kredietoperatie | Het overzicht van wat er voor één factureerbare handeling in rekening is gebracht en vergoed |
Elke bron wordt gecontroleerd aan de hand van het bijbehorende account. Klanten hoeven alleen openbare ID’s te bewaren en mogen geen implementatiedetails afleiden uit ID’s, bestandsnamen of downloadadressen.
Gebruikelijke oproepstroom
Section titled “Gebruikelijke oproepstroom”- Maak een invoerbron aan of kies er een.
- Zorg ervoor dat het account over credits beschikt: het saldo wordt vóór de start van de taak gecontroleerd tegen een drempelwaarde, en het werkelijke gebruik wordt in rekening gebracht zodra de taak is voltooid.
- Maak de taak aan met een
Idempotency-Key. - Controleer de taakstatus; bestandstranslatietaken kunnen ook SSE of webhooks gebruiken.
- Lees de resultaten en het creditrecord voor deze taak.
Identiteit
Section titled “Identiteit”Externe integraties gebruiken altijd API-sleutels, met dezelfde machtigingen als het account dat de sleutel heeft aangemaakt. Zie authenticatie .
Snelstart → Upload een bestand, maak een taak aan, controleer de status en download de resultaten