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

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

Запрос

Заметка: Either the project key or combination of имя пользователя и account key can be passed to this endpoint. Project identifier is passed in both cases.

POST https://api.crowdin.com/api/project/{идентификатор-проекта}/issues?key={ключ-проекта}
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 необязательный строка Defines the path of the file issues are associated with.
If the file path is not specified the method will get issues associated with all the project files.
language optional строка Defines the language issues are associated with. If the language is not specified the method will get issues associated with all the project languages.
Crowdin language codes.
date_from optional строка Начало временного периода для поиска. Используйте следующий формат даты/времени ISO 8601: YYYY-MM-DD±hh:mm
date_to optional строка Конец временного периода для поиска. Используйте следующий формат даты/времени ISO 8601: YYYY-MM-DD±hh:mm
json необязательный строка Может не содержать никакого значения. Определяет, что ответ должен быть в формате JSON.
jsonp необязательный строка Имя функции обратного вызова. Определяет, что ответ должен быть в JSONP.
Переменные
project-identifier обязательный строка Project identifier.
project-key optional строка Project API key. Either the project-key or combination of username and account-key are required.
username optional строка Your username in Crowdin. Either the project-key or combination of username and account-key are required.
account-key optional строка Your account API key. Either the project-key or combination of username and account-key are required.

Ответ

Если метод завершается успешно, он возвращает XML-структуру, как показано ниже:
<?xml version="1.0" encoding="ISO-8859-1"?>
<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>unresolved</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>John Doe</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>unresolved</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>John Doe</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>unresolved</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>John Doe</user>
    </issue>
</issues>
Пример ответа при неудавшемся запросе:
<?xml version="1.0" encoding="ISO-8859-1"?>
<error>
    <code>1</code>
    <message>The requested project does not exist or the API key is not valid.</message>
</error>

Примеры

  curl \
    -F "type=general_question" \
    -F "status=unresolved" \
    -F "date_from=2017-01-01" \
    https://api.crowdin.com/api/project/{идентификатор-проекта}/issues?key={ключ-проекта}
<?php
$post_params = array();
$request_url = 'https://api.crowdin.com/api/project/{project-identifier}/issues?key={project-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;

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