Настройка интеграции с API

Crowdin provides RESTful API with XML or JSON over HTTP using GET or POST methods. Listed below are all the available API methods, which allows you to create projects in Crowdin, add and update files, download translations or integrate localization with your development process.

Получение и использование API ключа

To find your project API key you have to login to your Crowdin account. Find the project, open Project Settings page and activate API tab.

Please note that almost all API calls require the Project Identifier (ID). You can find your project identifier right above the API key.

Выполнение запросов

For every API request you make, you'll need to present the API access key as the main URI parameter to be authenticated. Keep the API key in secret! It should be guarded just as your regular account password.

Here's an example and principle of API request URI forming.

GET https://api.crowdin.com/api/project/{идентификатор-проекта}/download/all.zip?key={ключ-проекта}

Typical API call URL looks like this: https://api.crowdin.com/api/project/. First placeholder (keyword in brackets) holds project identifier. API access key is specified as a URI parameter.

Методы

Добавить файл

Добавить новый файл в Crowdin проект.

Обновить файл

Upload latest version of your localization file to Crowdin.

Удалить файл

Delete file from Crowdin project. All the translations will be lost without ability to restore them.

Загрузить перевод

Upload existing translations to your Crowdin project.

Состояние перевода

Track overall translation and proofreading progresses of each target language. Default response format is XML.

Состояние языка

Get the detailed translation progress for specified language.

Сведения о проекте

Просмотреть детали проекта на Crowdin.

Скачать переводы

Download ZIP file with translations. You can choose the language of translation you need or download all of them at once.

Экспортировать файл

This method exports single translated files from Crowdin. Additionally, it can be applied to export XLIFF files for offline localization.

Экспортировать переводы

Build ZIP archive with the latest translations.

Предварительный перевод

Pre-translate Crowdin project files.

Проекты пользователя

Получить список проектов.

Создать проект

Создание Crowdin проекта.

Редактировать проект

Редактирование Crowdin проекта.

Удалить проект

Delete Crowdin project with all translations.

Добавить папку

Добавить новую папку в 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 file.

Загрузка глоссария в проект

Загрузить свои словари для проект crowdin в ТБС, CSV или xls/xlsx файлов форматы файлов.

Скачивание памяти переводов

Download Crowdin project Translation Memory as TMX file.

Загрузка памяти переводов в проект

Upload your Translation Memory for Crowdin Project in TMX, CSV or XLS/XLSX file format.

Поддерживаемые языки

Get supported languages list with Crowdin codes mapped to locale name and standardized codes.

Псевдо-экспорт

Generate pseudotranslation files for the whole project.

Загрузка псевдо-перевода

Download ZIP file with pseudo translations.

Export Costs Estimation Report

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.

Download Costs Estimation Report

Download previously generated Costs Estimation report.

Export Translation Costs Report

Generate Translation Costs report to calculate the real translation cost and know how much your translators and proofreaders should be paid.

Скачать отчёт стоимости перевода

Download previously generated Translation Costs report.

Export Top Members Report

Generate Top Members report to know who contributed the most to your project's translation during the specified date range.

Download Top Members Report

Download previously generated Top Members report.