Перейти к содержимому

Обзор платформы

API OmniDoc обслуживает рабочие процессы файлов и контента в рамках одной учётной записи. Пользователь создаёт ресурсы с помощью API‑ключа, а затем использует полученные стабильные идентификаторы для их запроса, объединения, обработки или загрузки.

РесурсНазначение
Документ / ФайлИсходные файлы и записи библиотеки файлов, принадлежащие аккаунту
Задача / ОперацияАсинхронный перевод, обработка документов или аудио- и видеопроцессинг
АртефактРезультаты, предоставляемые заданием для предварительного просмотра или загрузки
Кредитная операцияЗапись о том, какая оплачиваемая операция была выставлена и возвращена

Каждый ресурс проверяется по отношению к соответствующей учетной записи. Клиентам необходимо хранить только общедоступные идентификаторы и не следует выводить детали реализации из идентификаторов, имен файлов или адресов загрузки.

  1. Создайте или выберите входной ресурс.
  2. Убедитесь, что у аккаунта есть кредиты: перед запуском задания проверяется баланс на соответствие пороговому значению, а фактическое потребление тарифицируется по его завершении.
  3. Создайте задание с Idempotency-Key.
  4. Проверьте статус задания; для перевода файлов также можно использовать SSE или вебхуки.
  5. Прочитайте результаты и журнал кредитов для этой задачи.

Внешние интеграции всегда используют API-ключи с теми же правами доступа, что и учетная запись, создавшая ключ. См. аутентификацию .