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ásmodell
Szekció neve “Erőforrásmodell”| Erőforrás | Cél |
|---|---|
| Dokumentum / Fájl | A fiókhoz tartozó forrásfájlok és fájlkönyvtár-bejegyzések |
| Munka / Művelet | Aszinkron fordítás, dokumentumfeldolgozás vagy audio- és videofeladatok |
| Artifact | Az eredmény, amelyet egy munkafolyamat előnézetként vagy letöltésként szolgáltat |
| Hitelügylet | Az 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.
Gyakori hívási folyamat
Szekció neve “Gyakori hívási folyamat”- Hozzon létre vagy válasszon egy bemeneti erőforrást.
- 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.
- Hozzon létre egy feladatot egy
Idempotency-Keysegítségével. - Ellenőrizze a feladat állapotát; a fájlfordítási feladatok SSE-et vagy webhookokat is használhatnak.
- Olvasd el az eredményeket és a munka hitelnyilvántartását.
Azonosság
Szekció neve “Azonosság”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 .
Gyorsindítás → Töltsön fel egy fájlt, hozzon létre egy feladatot, ellenőrizze annak állapotát és töltse le az eredményeket.