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

Crowdin предоставляет RESTful API с XML или JSON через HTTP, используя методы GET или POST. Ниже перечислены все доступные методы API, которые позволяют создавать проекты в Crowdin, добавлять и обновлять файлы, скачивать переводы или интегрировать локализацию с процессом разработки.

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

Чтобы найти API ключ вашего проекта, вы должны войти в свою учетную запись Crowdin. Найдите проект, откройте страницу настроек проекта и активируйте вкладку API.

Обратите внимание, что почти для всех вызовов API требуется идентификатор проекта (ID). Вы можете найти идентификатор своего проекта прямо над ключом API.

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

Для каждого запроса API, который вы делаете, вам нужно представить ключ доступа API в качестве основного параметра URI для аутентификации. Держите ключ API в секрете! Он должен быть защищен так же, как ваш обычный пароль учетной записи.

Вот пример и принцип формирования URI запроса к API.

GET https://api.crowdin.com/api/project/{project-identifier}/download/all.zip?key={project-key}

Типичный URL вызов API выглядит следующим образом: https://api.crowdin.com/api/project/ , Первый заполнитель (ключевое слово в скобках) содержит идентификатор проекта. Ключ доступа API указывается в качестве параметра URI.

Использование Postman

Postman - это инструмент, который позволяет вам работать с Crowdin API простым способом.

Все доступные методы Crowdin API уже сохранены как коллекция в Postman. Нажмите Выполнить в Postman, чтобы импортировать и открывать эту коллекцию прямо в приложении Postman.

Методы

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

Add a new file to Crowdin project.

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

Upload the latest version of your source files (the ones, that should be localized) to your Crowdin project.

Удалить файл

Удалить файл из проекта Crowdin. Все переводы будут потеряны без возможности их восстановления.

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

Загрузить существующие переводы в ваш проект Crowdin.

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

Отследить общие прогрессы перевода и утверждения для каждого целевого языка. Формат ответа по умолчанию — XML.

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

Получить подробные сведения о прогрессе перевода для указанного языка.

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

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

Возникшие замечания

Получить список проблем, созданных через редактор.

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

Этот метод экспортирует один файл перевода из Crowdin. Также, он может быть применен для экспорта XLIFF файлов для автономного перевода.

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

Построить ZIP архив с последними переводами.

Статус экспорта переводов

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

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

Скачать ZIP-архив с переводами. Вы можете выбрать нужный язык перевода или скачать их все сразу.

Pre-Translation

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

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

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

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

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

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

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

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

Удалить проект Crowdin со всеми переводами.

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

Добавить новую папку в Crowdin проект.

Изменить папку

Переименовать каталог или изменить его атрибуты. При переименовании каталога путь не может быть изменен (это означает, что параметр new_name не может содержать путь, только имя).

Удалить папку

Удалить каталог проекта Crowdin. Все вложенные файлы и каталоги также будут удалены.

Скачать словарь

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.

Скачать отчет об оценке затрат

Загрузить ранее созданный отчет об оценке затрат.

Экспортировать отчет расходов на перевод

Сформировать отчет о затратах на перевод, чтобы рассчитать реальную стоимость перевода и узнать, сколько нужно заплатить вашим переводчикам и редакторам.

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

Загрузите ранее созданный отчет о затратах на перевод.

Экспортировать отчет топа участников

Сформировать отчет «Лучшие участники», чтобы узнать, кто внес наибольший вклад в перевод вашего проекта за указанный период времени.

Скачать отчет топа участников

Загрузить ранее созданный отчет лучших участников.

Была ли эта статья полезной?