Зарегистрируйтесь как разработчик и получите API-ключ
Предоставляет RESTful API для перевода документов с поддержкой автоматизированного управления задачами перевода, обеспечения терминологической согласованности на основе глоссариев и запросов поддерживаемых форматов, языков и моделей, что позволяет легко создавать эффективные рабочие процессы перевода и управлять учетными записями пользователей.
Начало работы
Для начала работы необходимо подать заявку на получение статуса разработчика.Подать заявку в качестве разработчика
После одобрения вы можете создать несколько API-ключей и включить соответствующий API-ключ в каждый API-запрос по мере необходимости.
Быстрое подключение
Базовый URL
https://shangyiai.com/api
Метод аутентификации
Authorization: [yourSecretKey]
JSON запрос
За исключением интерфейса загрузки файлов, интерфейсы по умолчанию используют POST JSON запросы, Content-Type — application/json.
Загрузка файла
Создание задачи перевода документа использует multipart/form-data, файл для перевода передаётся в поле file.
Универсальный ответ на ошибку
В случае неудачного запроса интерфейс возвращает JSON, поле error содержит фиксированное английское сообщение об ошибке. Рекомендуется в первую очередь обрабатывать ошибки по HTTP status code, поле error использовать для отображения или записи в лог.
{
"error": "Invalid API key."
}Правила кодов статусов ошибок
Все ответы с ошибками v1 API сохраняют одинаковую структуру, обрабатывайте их согласно следующим правилам HTTP status code.
- 400 Bad Request
- Отсутствуют обязательные параметры, неверный формат параметров или значения перечислений, отсутствует загружаемый файл, ошибка сохранения загрузки или ошибка обработки задачи.
- 401 Unauthorized
- Отсутствует или недействителен ключ API.
- 402 Payment Required
- Недостаточно кредитов для предварительного просмотра, полного перевода или текстового перевода.
- 404 Not Found
- Задача или глоссарий не существует, были удалены, не принадлежат текущему аккаунту API или не были созданы через API.
- 409 Conflict
- Текущий статус задачи не позволяет выполнить запрошенную операцию.
- 500 Internal Server Error
- Неожиданное исключение сервера. Ошибка ответа зафиксирована как "Внутренняя ошибка сервера.".
Рекомендуемый процесс интеграции
1. Создать задачу
Загрузить файл и создать задачу перевода, возвращает taskId.
2. Проверить прогресс
Опрашивать статус задачи до получения Completed, Terminated или Cancelled.
3. Получить результат
Скачать файл перевода или прочитать оригинал и перевод в JSON.
4. Управлять задачами
Оплата по мере использования полного перевода, перезапуск задачи, редактирование текста или удаление задачи.