Для керівників проекту

Для перекладачів

Для розробників

API v1
Мови
Вебхуки
IP Addresses

Компанія

Створити проект

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 API v2
Створення Crowdin проекту.

Запит

POST https://api.crowdin.com/api/account/create-project?account-key={ключ-акаунту}

Параметри

Ім'я Значення Опис
login обов'язковий рядок Ім'я вашого облікового запису на Crowdin.
name обов'язковий рядок Назва проекту.
identifier обов'язковий рядок Ідентифікатор проекту. Повинен бути унікальним серед інших проектів Crowdin.
source_language обов'язковий рядок Мова вихідних файлів. мовний код Crowdin.
languages обов'язковий масив Масив мовних кодів на які проект повинен бути перекладений.
join_policy обов'язковий рядок Політика приєднання до проекту. Прийнятними значеннями є:
  • відкрити
  • private
language_access_policy необов'язковий рядок Визначає, як учасники проекту можуть отримати доступ до цільових мов. Прийнятними значеннями є:
  • "відкритий" - будь-який перекладач може отримати доступ до будь-якої мови. (за замовчуванням)
  • "помірний" - перекладач має доступ до певної мови.
hide_duplicates необов'язковий число Визначає, чи повинні дубльовані рядки відображатися для перекладачів, або вони повинні бути прихованими і автоматично перекладеними. Прийнятними значеннями є:
  • 0: Показувати - перекладачі будуть перекладати кожен рядок окремо
  • 1: Приховати - для всіх дублікатів буде застосований один переклад
  • 2: Показувати, але автоматично перекладати їх
  • 3: Показувати (рекомендується для версій) - дублікати будуть приховані тільки між версіями
export_translated_only необов'язковий bool Визначає, чи будуть експортовані тільки перекладені рядки в кінцевий файл. Ми не рекомендуємо встановлювати цю опцію, якщо у вашому проекті є текстові (* .html, * .txt, * .docx і т. п.) документи, оскільки вони можуть стати причиною пошкодження підсумкових файлів. Доступні значення: 1 або 0.
export_approved_only необов'язковий bool Якщо встановлено 1, то тільки затверджені переклади будуть експортовані в підсумковий ZIP-файл. Доступні значення: 1 або 0.
auto_translate_dialects необов'язковий bool Неперекладені рядки на діалекті мови будуть автоматично перекладені в експортованих файлі, використовуючи переклад з основної мови. Доступні значення: 1 або 0.
public_downloads необов'язковий bool Визначає, чи буде кнопка "Завантажити" видна всім на веб-сторінках Crowdin. Доступні значення: 1 або 0.
use_global_tm необов'язковий bool Визначає, чи будуть використані переклади з Глобальної пам'яті перекладів Crowdin. Якщо ця опція використовується, всі переклади вашого проекту будуть автоматично передані в Глобальну пам'ять перекладу. Доступні значення: 1 або 0.
logo необов'язковий файл Емблема проекту в Crowdin.
cname необов'язковий рядок Власне доменне ім'я проекту Crowdin.
description необов'язковий рядок Опис проекту.
in_context необов'язковий bool Визначає, чи повинен бути активований контекстний переклад в проекті. Доступні значення: 1 або 0.
pseudo_language необов'язковий рядок Вкажіть код мови для In-Context псевдо-мови, яка буде зберігати деякі операційні дані.
qa_checks необов'язковий масив Визначає, чи повинна бути активована перевірка КЯ (контроль якості) в проекті. В якості ключа необхідно вказати параметр перевірки КЯ (Огляд параметрів перевірки КЯ). Можливі ключі:
  • "enabled" - включення або відключення перевірки якості
  • "empty" - порожній переклад
  • "size" — проблеми довжини
  • "tags" - невідповідність тегів
  • "spaces" - невідповідність прогалин
  • "variables" — невідповідність змінних
  • "punctuation" - невідповідність пунктуації
  • "symbol_register" - невідповідність регістру символів
  • "special_symbols" - невідповідність спеціальних символів
  • "wrong_translation" - проблеми з «неправильним перекладом»
  • "spellcheck" - орфографія
  • "icu" - синтаксис ICU
Доступні значення: 1 або 0.
Увага!Ця опція доступна тільки на тарифних планах для організацій.
webhook_file_translated необов'язковий рядок Відкрити цю URL-адресу, коли один з файлів проекту перекладено. URL-адреса буде відкрита з "проектом" - ідентифікатором проекту, "мовою" - кодом мови, "file_id" - Crowdin ідентифікатор файлу і "файлом" - ім'ям файлу.
webhook_file_proofread необов'язковий рядок Відкрити цю URL-адресу, коли один з файлів проекту пройшов коректуру. URL-адреса буде відкрита з "проектом" - ідентифікатором проекту, "мовою" - кодом мови, "file_id" - Crowdin ідентифікатор файлу і "файлом" - ім'ям файлу.
webhook_project_translated необов'язковий рядок Відкрийте цю URL-адресу після завершення перекладу проекту. Разом з URL буде відкрито "project" - ідентифікатор проекту та "language" - код мови.
webhook_project_proofread необов'язковий рядок Відкрийте цю URL-адресу після завершення перевірки проекту. Разом з URL буде відкрито "project" - ідентифікатор проекту та "language" - код мови.
json необов'язковий рядок Може не містити значення. Визначає, що відповідь має бути в форматі JSON.
jsonp необов'язковий рядок Назва функції зворотного виклику. Визначає, що відповідь має бути в форматі JSONP.
Variables
account-key рядок API ключ облікового запису Crowdin.

Відповідь

Якщо метод успішний, відповідь буде містити XML-структуру, як показано нижче (якщо language_access_policy = open). 
<?xml version="1.0" encoding="UTF-8"?>
<project>
  <success>1</success>
  <invitation>http://translate.example.com/project/test-project-api/invite</invitation>
  <url>http://translate.example.com/project/test-project-api</url>
  <key>ca51cef8f852425496b1cdd3e86fea88</key>
</project>
Приклад відповіді для проектів з "Moderate" language_access_policy. 
<?xml version="1.0" encoding="UTF-8"?>
<project>
  <success>1</success>
  <invitation>
    <item>
      <language>Українська</language>
      <translator>http://translate.example.com/project/test-project-api/invite?d=7585662585d5d32307d3937373</translator>
      <proofreader>http://translate.example.com/project/test-project-api/invite?d=3585k635r4d5d32307d3937373</proofreader>
    </item>
  </invitation>
  <url>https://crowdin.com/project/test-project-api</url>
  <key>d13720ba72204273af0321ca980945ec</key>
</project>
Приклад невдалого запиту: 
<?xml version="1.0" encoding="UTF-8"?>
<error>
  <code>12</code>
  <message>Ключ облікового запису недійсний</message>
</error>

Приклади

curl \
  -F "login=admin" \
  -F "logo=@logo.png" \
  -F "name=This is a test project" \
  -F "identifier=test-project-api" \
  -F "description=Brief Description" \
  -F "hide_duplicates=1" \
  -F "cname=translate.example.com" \
  -F "join_policy=open" \
  -F "languages[]=fr" \
  -F "languages[]=ru" \
  -F "export_approved_only=1" \
  -F "public_downloads=1" \
  -F "source_language=en" \
  -F "qa_checks[enabled]=1" \
  https://api.crowdin.com/api/account/create-project?account-key={account-key}
<?php
$post_params = array();
$request_url = 'https://api.crowdin.com/api/account/create-project?account-key={account-key}';
$post_params['login'] = 'admin';
$post_params['name'] = 'Test Project';
$post_params['identifier'] = 'api-test-project';
$post_params['join_policy'] = 'private';
$post_params['languages[0]'] = 'fr';
$post_params['languages[1]'] = 'uk';
$post_params['source_language'] = 'en';
$post_params['qa_checks[enabled]'] = 1;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $request_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_params);

$result = curl_exec($ch);
curl_close($ch);

echo $result;

Ця стаття була корисною?