Обзор платформы
API OmniDoc обслуживает рабочие процессы файлов и контента в рамках одной учётной записи. Пользователь создаёт ресурсы с помощью API‑ключа, а затем использует полученные стабильные идентификаторы для их запроса, объединения, обработки или загрузки.
Модель ресурсов
Заголовок раздела «Модель ресурсов»| Ресурс | Назначение |
|---|---|
| Документ / Файл | Исходные файлы и записи библиотеки файлов, принадлежащие аккаунту |
| Задача / Операция | Асинхронный перевод, обработка документов или аудио- и видеопроцессинг |
| Артефакт | Результаты, предоставляемые заданием для предварительного просмотра или загрузки |
| Кредитная операция | Запись о том, какая оплачиваемая операция была выставлена и возвращена |
Каждый ресурс проверяется по отношению к соответствующей учетной записи. Клиентам необходимо хранить только общедоступные идентификаторы и не следует выводить детали реализации из идентификаторов, имен файлов или адресов загрузки.
Обычный сценарий вызова
Заголовок раздела «Обычный сценарий вызова»- Создайте или выберите входной ресурс.
- Убедитесь, что у аккаунта есть кредиты: перед запуском задания проверяется баланс на соответствие пороговому значению, а фактическое потребление тарифицируется по его завершении.
- Создайте задание с
Idempotency-Key. - Проверьте статус задания; для перевода файлов также можно использовать SSE или вебхуки.
- Прочитайте результаты и журнал кредитов для этой задачи.
Идентичность
Заголовок раздела «Идентичность»Внешние интеграции всегда используют API-ключи с теми же правами доступа, что и учетная запись, создавшая ключ. См. аутентификацию .
Быстрый старт → Загрузите файл, создайте задание, проверьте его статус и загрузите результаты.