Настройка интеграции с API
Please consider that API 2.0 is now the preferred version to be used. The old API will remain fully functional until the end of 2021.
Crowdin предоставляет RESTful API с XML или JSON через HTTP, используя методы GET или POST. Ниже перечислены все доступные методы API, которые позволяют создавать проекты в Crowdin, добавлять и обновлять файлы, скачивать переводы или объединить локализацию с процессом разработки.
Получение и использование API ключа
Чтобы найти API ключ вашего аккаунта, вам нужно войти в свой аккаунт Crowdin. Откройте настройки аккаунта и переключитесь на вкладку API.
Обратите внимание, что почти все вызовы API требуют идентификатор проекта (ID). Вы можете найти идентификатор вашего проекта на вкладке Настройки проекта > API и Webhooks.
Выполнение запросов
Для каждого запроса API вам необходимо представить ключ API учетной записи и имя пользователя в качестве основных параметров URI для аутентификации. Держите API ключ вашего аккаунта в секрете! Он должен быть защищен так же, как ваш обычный пароль учетной записи.
Вот пример и принцип формирования URI запроса к API.
GET https://api.crowdin.com/api/project/{project-identifier}/download/all.zip?login={username}&account-key={account-key}
Типичный API вызов URL выглядит так: https://api.crowdin.com/api/project/. Первый заполнитель (ключевое слово в скобках) содержит идентификатор проекта. Ключ API учетной записи и имя пользователя указываются как параметры URI.
Лимиты
Количество одновременных вызовов API на одну учетную запись составляет 20 запросов. Если лимит превышен, появится код ошибки 429 с сообщением: "Для этой конечной точки достигнуто максимальное количество одновременных запросов. Пожалуйста, попробуйте еще раз чуть позже.
Использование Postman
Postman - это инструмент, который позволяет вам работать с Crowdin API простым способом.
Все доступные методы Crowdin API уже сохранены как коллекция в Postman. Нажмите Запустить в Postman , чтобы импортировать и открыть эту коллекцию прямо в вашем приложении Postman.
Методы
Добавить файл
Добавление нового файла в проект Crowdin.
Обновить файл
Upload the latest version of your source files (the ones, that should be localized) to your Crowdin project.
Удалить файл
Удалить файл из проекта Crowdin. Все переводы будут потеряны без возможности их восстановления.
Загрузить перевод
Загрузить существующие переводы в ваш проект Crowdin. Method is not working for Assets localization.
Состояние перевода
Track overall translation and proofreading progresses of each target language. Default response format is XML.
Состояние языка
Получить подробные сведения о прогрессе перевода для указанного языка.
Сведения о проекте
Просмотреть детали проекта Crowdin.
Возникшие замечания
Получить список проблем, созданных через редактор.
Экспортировать файл
Этот метод экспортирует отдельные переведенные файлы из Crowdin. Кроме того, он может быть применен для экспорта файлов XLIFF для автономной локализации.
Экспортировать переводы
Построить ZIP архив с последними переводами.
Статус экспорта переводов
Получить статус экспорта переводов.
Скачать переводы
Скачать ZIP файл с переводами. Вы можете выбрать язык перевода, который вам нужен, или загрузить их все сразу.
Предварительный перевод
Предварительный перевод файлов проекта Crowdin.
Проекты пользователя
Получить список проектов.
Создать проект
Создание проекта Crowdin.
Редактировать проект
Редактирование Crowdin проекта.
Удалить проект
Удалить проект Crowdin со всеми переводами.
Добавить папку
Добавление новой папку в проект Crowdin.
Изменить папку
Переименование каталога или изменение его атрибутов. При переименовании каталога путь не может быть изменен (это означает, что параметр new_name содержит только имя, но не путь).
Удалить папку
Удалить папку проекта Crowdin. Все вложенные файлы и каталоги также будут удалены.
Скачать словарь
Скачать словари проекта Crowdin как TBX, CSV или файл XLSX.
Загрузить термины в проект
Загрузить свои термины для проекта Crowdin в форматах файлов TBX, CSV или XLS/XLSX.
Скачивание памяти переводов
Скачать память переводов Crowdin как TMX, CSV или файл XLSX.
Загрузка памяти переводов в проект
Загрузить свои файлы памяти переводов для проекта Crowdin в форматах файлов TMX, CSV или XLS/XLSX.
Поддерживаемые языки
Получите список поддерживаемых языков с кодами Crowdin, сопоставленными с названием локали и стандартизированными кодами.
Экспорт псевдо-перевода
Создать файлы псевдоперевода для всего проекта.
Загрузка псевдо-перевода
Загрузить ZIP файл с псевдо-переводами.
Экспорт отчета об оценке затрат
Сгенерируйте отчет об оценке затрат, чтобы понять, как планировать бюджет. Этот отчет позволяет рассчитать приблизительную стоимость перевода непереведенных на текущий момент строк в проекте.
Скачать отчет об оценке затрат
Загрузить ранее созданный отчет об оценке затрат.
Экспортировать отчет расходов на перевод
Сформировать отчет о затратах на перевод, чтобы рассчитать реальную стоимость перевода и узнать, сколько нужно заплатить вашим переводчикам и редакторам.
Скачать отчёт о стоимости перевода
Загрузите ранее созданный отчет о затратах на перевод.
Экспортировать отчет топа участников
Сформировать отчет «Лучшие участники», чтобы узнать, кто внес наибольший вклад в перевод вашего проекта за указанный период времени.
Скачать отчет топа участников
Загрузить ранее созданный отчет лучших участников.
Crowdin API Java SDK
Crowdin API Java SDK поможет вам сгладить работу со всеми методами Crowdin API в вашем проекте Java, таких как добавление и обновление файлов, загрузка переводов или интеграция локализации с процессом разработки.