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

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

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

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

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

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

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

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

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

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 простым способом.

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

Методы