Prehľad platformy
API OmniDoc spravuje pracovné postupy s súbormi a obsahom v rámci jedného účtu. Volajúci vytvorí prostriedky pomocou kľúča API a následne použije stabilné ID, ktoré dostane späť, na ich dotazovanie, kombinovanie, spracovanie alebo sťahovanie.
Model zdrojov
Section titled “Model zdrojov”| Zdroj | Účel |
|---|---|
| Dokument / Súbor | Zdrojové súbory a záznamy knižnice súborov vlastnené účtom |
| Práca / Operácia | Asynchrónne preklady, spracovanie dokumentov alebo práce s audio a video súbormi |
| Artifact | Výsledky, ktoré práca prináša na náhľad alebo na stiahnutie |
| Kreditná operácia | Záznam o tom, čo jedna účtovateľná akcia účtovala a refundovala |
Každý zdroj je overený vzhľadom na príslušný účet. Klienti musia uchovávať iba verejné ID a nemali by vyvodzovať podrobnosti implementácie z ID, názvov súborov alebo adries na stiahnutie.
Bežný tok hovoru
Section titled “Bežný tok hovoru”- Vytvorte alebo vyberte vstupný zdroj.
- Uistite sa, že účet má kredity: zostatok sa skontroluje voči prahu pred spustením úlohy a skutočné použitie sa účtuje po jej dokončení.
- Vytvorte úlohu s
Idempotency-Key. - Skontrolujte stav úlohy; pre úlohy na preklad súborov možno použiť aj SSE alebo webhooky.
- Prečítajte si výsledky a záznam o úhrade pre túto prácu.
Identita
Section titled “Identita”Externé integrácie vždy používajú API kľúče s rovnakými povoleniami ako účet, ktorý kľúč vytvoril. Pozrite si autentifikáciu .
Rýchly štart → Nahrajte súbor, vytvorte úlohu, skontrolujte jej stav a stiahnite výsledky