Огляд платформи
API OmniDoc обслуговує робочі процеси з файлами та вмістом в межах одного облікового запису. Користувач створює ресурси за допомогою ключа API, а потім використовує отримані стабільні ідентифікатори для їх запиту, об’єднання, обробки або завантаження.
Модель ресурсів
Section titled “Модель ресурсів”| Ресурс | Призначення |
|---|---|
| Документ / Файл | Вихідні файли та записи бібліотеки файлів, що належать обліковому запису |
| Робота / Операція | Асинхронний переклад, обробка документів або роботи з аудіо та відео |
| Артефакт | Результати, які надає завдання для перегляду або завантаження |
| Кредитна операція | Запис про те, яку платну дію було нараховано та відшкодовано |
Кожен ресурс перевіряється відповідно до облікового запису, якому він належить. Клієнтам потрібно лише зберігати публічні ідентифікатори та не слід робити висновки про деталі реалізації на основі ідентифікаторів, імен файлів або адрес завантажень.
Звичайний сценарій виклику
Section titled “Звичайний сценарій виклику”- Створіть або виберіть вихідний ресурс.
- Переконайтеся, що на рахунку є кошти: баланс перевіряється відносно порогового значення перед початком завдання, а фактичне використання тарифікується після його завершення.
- Створіть завдання з
Idempotency-Key. - Перевірте статус завдання; для перекладу файлів також можна використовувати SSE або вебгівки.
- Прочитайте результати та запис про оплату за це завдання.
Тотожність
Section titled “Тотожність”Зовнішні інтеграції завжди використовують ключі API, які мають ті самі дозволи, що й обліковий запис, який створив цей ключ. Див. аутентифікація .
Швидкий старт → Завантажте файл, створіть завдання, перевірте його стан та завантажте результати