Виниклі зауваження

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
Отримати список проблем, створених через редактор.

Запит

Note: Use the combination of project identifier, username, and account key to pass to this endpoint.

POST https://api.crowdin.com/api/project/{project-identifier}/issues?login={username}&account-key={account-key}

Параметри

Ім'я Значення Опис
type необов'язковий рядок Визначає тип проблеми.
Прийнятними значеннями є:
  • "general_question" — загальне питання
  • "translation_mistake" — поточний варіант перекладу неправильний
  • "context_request" — відсутня контекстна інформація
  • "source_mistake" — помилка в заданому рядку
  • "all" — всі перераховані вище типи проблем (за замовчуванням)
status необов'язковий рядок Визначає стан вирішення проблеми.
Прийнятними значеннями є:
  • "unresolved" — невирішені проблеми
  • "resolved" — вирішені проблеми
  • "all" — всі перераховані вище стани (за замовчуванням)
file необов'язковий рядок Визначає шлях до файлу, пов'язаного з проблемами.
Якщо шлях до файлу не визначений, то метод буде мати проблеми, пов'язані з усіма файлами проекту.
language необов'язковий рядок Визначає мову з якою пов'язані проблеми. Якщо мова не вказана, метод отримає проблеми, пов'язані з усіма мовами проекту.
мовні коди Crowdin.
date_from необов'язковий рядок Issues added from. Використовує наступний формат ISO 8601: YYYY-MM-DD±hh:mm
date_to необов'язковий рядок Issues added from. Використовує наступний формат ISO 8601: YYYY-MM-DD±hh:mm
json необов'язковий рядок Може не містити значення. Defines that the response should be in JSON.
jsonp необов'язковий рядок Назва функції зворотного виклику. Defines that the response should be in JSON.
Variables
project-identifier рядок Ідентифікатор проекту.
login рядок Ваше ім'я користувача в Crowdin.
account-key рядок API ключ вашого облікового запису.

Відповідь

If the method is successful it returns an XML structure, as it's shown below:
<?xml version="1.0" encoding="UTF-8"?>
<issues>
    <issue>
        <source_string>Назва проекту</source_string>
        <context>Headline 3 XPath: /html/body/div/div/h3</context>
        <comment>Source string mistake</comment>
        <created>2017-12-18T14:19:05+0000</created>
        <type>source_mistake</type>
        <status>повторно відкрити</status>
        <file>/crowdin_sample_webpage.html</file>
        <language>
            <name>French</name>
            <code>fr</code>
        </language>
        <string_url>https://crowdin.com/translate/project-issues/3624/en-uk#14342648</string_url>
        <user>Джон Доу</user>
    </issue>
    <issue>
        <source_string>Current Password</source_string>
        <context>current_password</context>
        <comment>wrong translation</comment>
        <created>2017-12-18T14:18:29+0000</created>
        <type>translation_mistake</type>
        <status>повторно відкрити</status>
        <file>/crowdin_sample_android.xml</file>
        <language>
            <name>French</name>
            <code>fr</code>
        </language>
        <string_url>https://crowdin.com/translate/project-issues/3625/en-uk#14342682</string_url>
        <user>Джон Доу</user>
    </issue>
    <issue>
        <source_string>Швидкий старт</source_string>
        <context>quick_start</context>
        <comment>Need more context</comment>
        <created>2017-12-18T14:18:01+0000</created>
        <type>context_request</type>
        <status>повторно відкрити</status>
        <file>/crowdin_sample_android.xml</file>
        <language>
            <name>French</name>
            <code>fr</code>
        </language>
        <string_url>https://crowdin.com/translate/project-issues/3625/en-uk#14342693</string_url>
        <user>Джон Доу</user>
    </issue>
</issues>
Unsuccessful response example:
<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>1</code>
    <message>Запитуваний проект не існує або API-ключ недійсний.</message>
</error>

Приклади

  curl \
    -F "type=general_question" \
    -F "status=unresolved" \
    -F "date_from=2017-01-01" \
    https://api.crowdin.com/api/project/{project-identifier}/issues?login={username}&account-key={account-key}
<?php
$post_params = array();
$request_url = 'https://api.crowdin.com/api/project/{project-identifier}/issues?login={username}&account-key={account-key}';
$post_params['type'] = 'general_question';
$post_params['status'] = 'unresolved';
$post_params['date_from'] = '2017-01-01';

$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;

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