Налаштування 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.
Зверніть увагу, що практично всі API-виклики вимагають ідентифікатор проекту (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}
Типова URL API-виклику виглядає так: https://api.crowdin.com/api/project/. Перший заповнювач (ключове слово в дужках) містить ідентифікатор проекту. Account API key and username are specified as a URI parameters.
Обмеження за запитами
Кількість одночасних API-викликів на обліковий запис становить 20 запитів. Якщо ліміт буде перевищено, з'явиться повідомлення з кодом помилки 429: "Досягнуто максимальну кількість одночасних запитів для цього кінцевого пункту. Спробуйте ще раз пізніше."
Використання Postman
Postman - це інструмент, який дозволяє вам працювати з Crowdin API простим способом.
Всі доступні методи Crowdin API вже зберігаються у вигляді колекції в Postman. Натисніть Виконати в Postman, щоб імпортувати і відкрити цю колекцію безпосередньо у вашій програмі Postman.
Методи
Додати файл
Додати новий файл в проект Crowdin.
Оновити файл
Завантажте останню версію ваших вихідних файлів (ті, які повинні бути локалізовані) в ваш проект Crowdin.
Видалити файл
Видалити файл з проекту Crowdin. Усі переклади будуть втрачені, без можливості відновлення.
Завантажити переклад
Вивантажити наявні переклади до вашого Crowdin проекту. Метод не працює для Локалізація додаткових матеріалів.
Статус перекладу
Відстежувати загальний прогрес перекладу і коректури з кожної цільової мови. Зумовлений формат відповіді - 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 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.