Przejdź do głównej zawartości

Przegląd platformy

Interfejs API OmniDoc obsługuje przepływy pracy plików i treści w ramach jednego konta. Wywołujący tworzy zasoby za pomocą klucza API, a następnie wykorzystuje otrzymane stałe identyfikatory do ich zapytywania, łączenia, przetwarzania lub pobierania.

ZasóbCel
Dokument / PlikPliki źródłowe i wpisy biblioteki plików należące do konta
Zadanie / OperacjaAsynchroniczne tłumaczenie, przetwarzanie dokumentów lub zadań audio i wideo
ArtykułWyniki dostarczone przez zadanie do podglądu lub pobrania
Operacja kredytowaRekord dotyczący jednej opłacalnej czynności, której koszt został naliczony i zwrócony

Każdy zasób jest sprawdzany w odniesieniu do konta właściciela. Klienci muszą zachować wyłącznie publiczne identyfikatory i nie powinni wywodzić szczegółów implementacyjnych z identyfikatorów, nazw plików lub adresów pobierania.

  1. Utwórz lub wybierz zasób wejściowy.
  2. Upewnij się, że konto posiada dostępne środki: saldo jest sprawdzane wobec progu przed rozpoczęciem zadania, a rzeczywiste zużycie jest rozliczane po jego zakończeniu.
  3. Utwórz zadanie z Idempotency-Key.
  4. Sprawdź status zadania; zadania tłumaczenia plików mogą również korzystać z SSE lub webhooków.
  5. Przeczytaj wyniki i zapis kredytowy dla tego zadania.

Zewnętrzne integracje zawsze używają kluczy API, z tymi samymi uprawnieniami co konto, które utworzyło klucz. Zobacz autoryzację .