Перейти до вмісту

Огляд платформи

API OmniDoc обслуговує робочі процеси з файлами та вмістом в межах одного облікового запису. Користувач створює ресурси за допомогою ключа API, а потім використовує отримані стабільні ідентифікатори для їх запиту, об’єднання, обробки або завантаження.

РесурсПризначення
Документ / ФайлВихідні файли та записи бібліотеки файлів, що належать обліковому запису
Робота / ОпераціяАсинхронний переклад, обробка документів або роботи з аудіо та відео
АртефактРезультати, які надає завдання для перегляду або завантаження
Кредитна операціяЗапис про те, яку платну дію було нараховано та відшкодовано

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

Звичайний сценарій виклику

Section titled “Звичайний сценарій виклику”
  1. Створіть або виберіть вихідний ресурс.
  2. Переконайтеся, що на рахунку є кошти: баланс перевіряється відносно порогового значення перед початком завдання, а фактичне використання тарифікується після його завершення.
  3. Створіть завдання з Idempotency-Key.
  4. Перевірте статус завдання; для перекладу файлів також можна використовувати SSE або вебгівки.
  5. Прочитайте результати та запис про оплату за це завдання.

Зовнішні інтеграції завжди використовують ключі API, які мають ті самі дозволи, що й обліковий запис, який створив цей ключ. Див. аутентифікація .