API
Переводите JSON и файлы, отслеживайте ход перевода и скачивайте готовые переводы со своего сервера.
Используйте API Lingo.dev для перевода контента вашего приложения. Задание локализации объединяет движок, исходный язык, целевые языки и один или несколько документов. Для каждого документа отслеживается перевод на каждый запрошенный язык. В большинстве форматов переводы сохраняются в отдельных файлах, а в каталогах строк Apple — в одном общем файле.
Базовый URL API — https://api.lingo.dev/v2. Храните учётные данные API на своём сервере. Начните с первого запроса на перевод, чтобы перевести два сообщения и сохранить результат.
Выберите входные данные #
| Ваш контент | С чего начать |
|---|---|
| JSON-объект, который уже есть в приложении | Перевести JSON. Передайте объект прямо в запросе на создание задания. |
| Файлы, например JSON, Markdown, HTML или ресурсы мобильных приложений | Перевести документы. Загрузите исходные байты и скачайте файлы в том же формате. |
| Несколько документов или целевых языков | Создать задание на перевод. Одно задание может содержать и встроенный JSON, и загруженные файлы. |
Во всех трёх случаях порядок один:
- Создайте задание и сохраните его ИД вместе с версией исходного контента.
- Загрузите каждый артефакт из массива
uploadsв ответе. Встроенные исходные данные JSON сохраняются при создании задания. - Запустите задание.
- Отслеживайте ход выполнения, пока не будут готовы нужные переводы документов.
- Скачайте каждый готовый перевод по его
status.downloadUrl.
При создании задания сохраняются данные о предстоящей работе. При запуске задание принимается к выполнению и начинается обработка. Успешный ответ на запрос создания — это ещё не готовый перевод.
Оцените объём работы перед созданием задания, если нужно узнать, какие переводы можно использовать повторно и сколько примерно будет стоить перевод.
Настройте перевод #
Явно укажите движок с помощью engineId. Он задаёт модели, глоссарии, правила и тональность бренда, а также пайплайн перевода. Ключ API должен давать доступ к переводу с помощью этого движка.
Для JSON добавьте контекст документа, подсказки и защищённые пути с помощью format.options. Для новой версии передайте предыдущий исходный контент и переводы, чтобы повторно использовать неизменившийся контент.
Ручная проверка позволяет специалистам с нужными правами одобрять или редактировать переводы, доступные для проверки, прежде чем пайплайн продолжит работу. В руководстве по рабочему процессу проверки описано, как связать отправку, проверку и получение переводов.
Сохраняйте состояние приложения вместе с заданием #
Прежде чем продолжить, сохраните ИД задания, версию исходного контента, ключи документов и запрошенные локали. При создании задания используйте заголовок Idempotency-Key: если ответ не позволит понять, создано ли задание, вы сможете повторить запрос без дублирования. Прежде чем отправлять новое задание взамен прежнего, получите данные о существующем.
Скачивайте готовые переводы, даже если другой перевод завершился с ошибкой. Публикуйте результат, только если он всё ещё соответствует версии исходного контента, которую ожидает приложение. Как согласовать эти шаги, описано в руководстве «Как построить рабочий процесс перевода».
О доступе и восстановлении после ошибок см. в разделах «Аутентификация», «Ошибки» и «Каталог ошибок».
Подготовьте и улучшите движок #
Провижининг формирует глоссарии, правила и тональность бренда на основе контента сайта или текста. Предложения для движка превращают обратную связь в предложения, которые вы можете проверить и применить. Проверьте сгенерированные рекомендации, прежде чем использовать их для перевода.