Preskočiť na obsah

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.

ZdrojÚčel
Dokument / SúborZdrojové súbory a záznamy knižnice súborov vlastnené účtom
Práca / OperáciaAsynchrónne preklady, spracovanie dokumentov alebo práce s audio a video súbormi
ArtifactVýsledky, ktoré práca prináša na náhľad alebo na stiahnutie
Kreditná operáciaZá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.

  1. Vytvorte alebo vyberte vstupný zdroj.
  2. 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í.
  3. Vytvorte úlohu s Idempotency-Key.
  4. Skontrolujte stav úlohy; pre úlohy na preklad súborov možno použiť aj SSE alebo webhooky.
  5. Prečítajte si výsledky a záznam o úhrade pre túto prácu.

Externé integrácie vždy používajú API kľúče s rovnakými povoleniami ako účet, ktorý kľúč vytvoril. Pozrite si autentifikáciu .