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.
Model zasobów
Dział zatytułowany „Model zasobów”| Zasób | Cel |
|---|---|
| Dokument / Plik | Pliki źródłowe i wpisy biblioteki plików należące do konta |
| Zadanie / Operacja | Asynchroniczne tłumaczenie, przetwarzanie dokumentów lub zadań audio i wideo |
| Artykuł | Wyniki dostarczone przez zadanie do podglądu lub pobrania |
| Operacja kredytowa | Rekord 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.
Typowy tok połączenia
Dział zatytułowany „Typowy tok połączenia”- Utwórz lub wybierz zasób wejściowy.
- 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.
- Utwórz zadanie z
Idempotency-Key. - Sprawdź status zadania; zadania tłumaczenia plików mogą również korzystać z SSE lub webhooków.
- Przeczytaj wyniki i zapis kredytowy dla tego zadania.
Tożsamość
Dział zatytułowany „Tożsamość”Zewnętrzne integracje zawsze używają kluczy API, z tymi samymi uprawnieniami co konto, które utworzyło klucz. Zobacz autoryzację .
Szybki start → Prześlij plik, utwórz zadanie, sprawdź jego status i pobierz wyniki