Tovább a tartalomhoz

Platform áttekintés

A OmniDoc API egyetlen fiókon belül kezeli a fájl- és tartalom-műveleti folyamatokat. A hívóprogram az API-kulccsal hoz létre erőforrásokat, majd a visszakapott stabil azonosítók segítségével lekérdezheti, összevetheti, feldolgozhatja vagy letöltheti azokat.

ErőforrásCél
Dokumentum / FájlA fiókhoz tartozó forrásfájlok és fájlkönyvtár-bejegyzések
Munka / MűveletAszinkron fordítás, dokumentumfeldolgozás vagy audio- és videofeladatok
ArtifactAz eredmény, amelyet egy munkafolyamat előnézetként vagy letöltésként szolgáltat
HitelügyletAz a rekord, amelyben feltüntetik, hogy egy számlázható tevékenység milyen összegért lett elszámolva és visszatérítve

Minden erőforrást a tulajdonos fiókkal összehasonlítanak. Az ügyfeleknek csupán a nyilvános azonosítókat kell megőrizniük, és nem szabad az azonosítókból, fájlnévből vagy letöltési címekből következtetniük a megvalósítási részletekre.

  1. Hozzon létre vagy válasszon egy bemeneti erőforrást.
  2. Győződjön meg róla, hogy a fióknak van jóváírása: az egyenleget a feladat elindulása előtt összehasonlítják egy küszöbértékkel, és a tényleges felhasználást a befejezéskor számlázzák.
  3. Hozzon létre egy feladatot egy Idempotency-Key segítségével.
  4. Ellenőrizze a feladat állapotát; a fájlfordítási feladatok SSE-et vagy webhookokat is használhatnak.
  5. Olvasd el az eredményeket és a munka hitelnyilvántartását.

A külső integrációk mindig API kulcsokat használnak, amelyek ugyanolyan jogosultságokkal rendelkeznek, mint a kulcs létrehozójának fiókja. Lásd hitelesítés .