Удалить файл

Delete file from Crowdin project. All the translations will be lost without ability to restore them.

Запрос

Заметка: Either use the combination of project identifier и project key or combination of project identifier, имя пользователя, and account key to pass to this endpoint.

POST https://api.crowdin.com/api/project/{идентификатор-проекта}/delete-file?key={ключ-проекта}
POST https://api.crowdin.com/api/project/{project-identifier}/delete-file?login={username}&account-key={account-key}

Параметры

Название Значение Описание
file обязательный строка File name that should be deleted.
branch необязательный строка The name of related version branch (Versions Management).
json необязательный строка Может не содержать значение. Указывает, что ответ должен быть в формате JSON.
jsonp необязательный строка Callback function name. Defines that response should be in JSONP format.
Переменные
project-identifier строка Project identifier.
project-key строка Project API key. Either the project-key or combination of username and account-key are required.
имя пользователя строка Your username in Crowdin. Either the project-key or combination of username and account-key are required.
account-key строка Your account API key. Either the project-key or combination of username and account-key are required.

Ответ

If successful, this method returns a XML structure, as it is shown below.
<?xml version="1.0" encoding="ISO-8859-1"?>
<success>
</success>
Образец ответа при неудавшемся запросе:
<?xml version="1.0" encoding="ISO-8859-1"?>
<error>
  <code>3</code>
  <message>API key is not valid</message>
</error>

Примеры

curl \
  -F "file=/directory/strings.xml" \
  https://api.crowdin.com/api/project/{project-identifier}/delete-file?key={project-key}
<?php
$post_params = array();
$request_url = 'https://api.crowdin.com/api/project/{project-identifier}/delete-file?key={project-key}';
$post_params['file'] = '/directory/strings.xml';

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

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