Настройка интеграции с 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. Listed below are all the available API methods that allow you to create projects in Crowdin, add and update files, download translations or integrate localization with your development process.
Acquiring and Using API Key
To find your Account API key you have to login to your Crowdin account. Open Account Settings page and switch to API tab.
Please note that almost all API calls require the Project Identifier (ID). You can find your project identifier in the Project settings > API & Webhooks tab.
Выполнение запросов
For every API request you make, you'll need to present the Account API key and username as main URI parameters to be authenticated. Keep your Account API key in secret! Он должен быть защищен так же, как ваш обычный пароль учетной записи.
Вот пример и принцип формирования URI запроса к API.
GET https://api.crowdin.com/api/project/{project-identifier}/download/all.zip?login={username}&account-key={account-key}
Typical API call URL looks like this: https://api.crowdin.com/api/project/. First placeholder (keyword in brackets) holds project identifier. Account API key and username are specified as a URI parameters.
Rate Limits
The number of simultaneous API calls per account is 20 requests. If the limit is exceeded, 429 error code will show up with a message: “Maximum number of concurrent requests for this endpoint is reached. Please try again shortly.”
Использование Postman
Postman - это инструмент, который позволяет вам работать с Crowdin API простым способом.
All the available Crowdin API methods are already saved as a collection in Postman. Click Run in Postman to import and open this collection directly in your Postman app.
Методы
Добавить файл
Добавить новый файл в Crowdin проект.
Обновить файл
Upload the latest version of your source files (the ones, that should be localized) to your Crowdin project.
Удалить файл
Delete file from Crowdin project. All the translations will be lost without ability to restore them.
Загрузить перевод
Загрузить существующие переводы в ваш проект Crowdin. Method is not working for Assets localization.
Состояние перевода
Track overall translation and proofreading progresses of each target language. Default response format is XML.
Состояние языка
Получить подробные сведения о прогрессе перевода для указанного языка.
Сведения о проекте
Просмотреть детали проекта Crowdin.
Возникшие замечания
Получить список проблем, созданных через редактор.
Экспортировать файл
This method exports single translated files from Crowdin. Additionally, it can be applied to export XLIFF files for offline localization.
Экспортировать переводы
Построить ZIP архив с последними переводами.
Статус экспорта переводов
Получить статус экспорта переводов.
Скачать переводы
Download a ZIP file with translations. You can choose the language of translation you need or download all of them at once.
Предварительный перевод
Предварительный перевод файлов проекта Crowdin.
Проекты пользователя
Получить список проектов.
Создать проект
Создание Crowdin проекта.
Редактировать проект
Редактирование Crowdin проекта.
Удалить проект
Удалить проект Crowdin со всеми переводами.
Добавить папку
Добавить новую папку в Crowdin проект.
Изменить папку
Rename directory or modify its attributes. When renaming directory the path can not be changed (it means new_name parameter can not contain path, name only).
Удалить папку
Delete Crowdin project directory. All nested files and directories will be deleted too.
Скачать словарь
Download Crowdin project glossaries as TBX, CSV, or XLSX file.
Загрузить термины в проект
Загрузить свои термины для проекта Crowdin в форматах файлов TBX, CSV или XLS/XLSX.
Скачивание памяти переводов
Download Crowdin project Translation Memory as TMX, CSV, or XLSX file.
Загрузка памяти переводов в проект
Загрузить свои файлы памяти переводов для проекта Crowdin в форматах файлов TMX, CSV или XLS/XLSX.
Поддерживаемые языки
Получите список поддерживаемых языков с кодами Crowdin, сопоставленными с названием локали и стандартизированными кодами.
Экспорт псевдо-перевода
Создать файлы псевдоперевода для всего проекта.
Загрузка псевдо-перевода
Загрузить ZIP файл с псевдо-переводами.
Экспорт отчета об оценке затрат
Generate Costs Estimation report to have an insight on how to plan the budget. This report allows you to calculate the approximate translation cost of currently untranslated strings in the project.
Скачать отчет об оценке затрат
Загрузить ранее созданный отчет об оценке затрат.
Экспортировать отчет расходов на перевод
Сформировать отчет о затратах на перевод, чтобы рассчитать реальную стоимость перевода и узнать, сколько нужно заплатить вашим переводчикам и редакторам.
Скачать отчёт о стоимости перевода
Загрузите ранее созданный отчет о затратах на перевод.
Экспортировать отчет топа участников
Сформировать отчет «Лучшие участники», чтобы узнать, кто внес наибольший вклад в перевод вашего проекта за указанный период времени.
Скачать отчет топа участников
Загрузить ранее созданный отчет лучших участников.
Crowdin API Java SDK
Crowdin API Java SDK helps you smooth the work with all Crowdin API methods in your Java project, such as adding and updating files, downloading translations or integrating localization with your development process.