README
Введение
Данный клиент разработан для работы с сайтом https://www.etxtru.ru.
Класс клиента генерируется автоматически на основе документации https://www.etxt.ru/api/
Инсталяция
composer require carono/etxtru-api
Использование
// Получение баланса
require '../vendor/autoload.php';
$client = new \carono\etxtru\Client();
$client->apiKey = 'token';
$client->password = 'password';
$response = $client->users()->getBalance();
// Создание заказа
$config = new \carono\etxtru\config\TasksSaveTaskConfig();
$config->public = 0;
$config->title = 'Задача 1';
$config->description = 'Описание';
$config->price = 5;
$config->price_type = 1;
$config->size = 500;
$config->id_folder = 'folder_name';
$config->deadline = '30.10.2018';
$config->id_category = 1938;
$config->file = fopen('/path/file.jpg', 'rb');
$response = $client->tasks()->saveTask($config);
Функция возвращает список тематических категорий заказов/статей
$client->categories();
Доступные методы
listCategories - Возвращает список тематический категорий заказов/статей, отсортированный по названию категории.
$client->categories()->listCategories();
Результат
| Параметр |
Описание |
| id_category |
Идентификатор категории |
| id_parent |
Идентификатор родительской категории |
| name |
Название категории |
| keyword |
Ключевое слово категории |
Функция возвращает список папок текущего пользователя
$client->folders();
Доступные методы
listFolders - Возвращает отсортированный список папок текущего пользователя.
$client->folders()->listFolders($sort);
Входные параметры
| Параметр |
Тип |
Описание |
| sort |
string |
date - сортировка по дате создания, name - по названию (по умолчанию) |
Результат
| Параметр |
Описание |
| id_category |
Идентификатор папки |
| id_parent |
Идентификатор родительской папки |
| name |
Название папки |
| depth |
Глубина вложенности папки |
| last |
Флаг, является ли папка последней по глубине вложенности |
addFolder - Cоздает папку для текущего пользователя.
$client->folders()->addFolder($name, $id_parent);
Входные параметры
| Параметр |
Тип |
Описание |
| name |
string |
Название создаваемой папки (длинна от 1 до 128 знаков) |
| id_parent |
int |
Идентификатор родительской папки или 0 (по умолчанию) для корневой папки |
Результат
| Параметр |
Описание |
| id_folder |
Идентификатор созданной папки |
moveToFolder - Фукнция перемещает объекты в папку.
$client->folders()->moveToFolder($id_folder, $type, $ids);
Входные параметры
| Параметр |
Тип |
Описание |
| id_folder |
string |
Идентификатор папки |
| type |
string |
Тип перемещаемых объектов. Значения: task - заказ archive - архивный заказ article - статья article_archive - архивная статья correction - коррекция bhv_task - задания |
| ids |
int (array) |
Массив идентификаторов перемещаемых объектов |
Результат
| Параметр |
Описание |
| count |
Количество перемещенных объектов |
Функция возвращает список исполнителей
$client->users();
Доступные методы
getList - Возвращает список исполнителей без сортировки.
$client->users()->getList($config);
Входные параметры
| Параметр |
Тип |
Описание |
| count |
int |
Число пользователей для выборке, не более 100 за запрос (по умолчанию) |
| from |
int |
Смещение от последней записи в выборке, по умолчанию 0 |
| rate_from |
int |
Фильтрация по рейтингу, начиная с данного значения |
| rate_out |
int |
Фильтрация по рейтингу, заканчивая данным значением |
| online |
int |
Флаг онлайн статуса на бирже, 1 - онлайн, 0 - офлайн, по умолчанию все вместе |
Результат
| Параметр |
Описание |
| id_user |
Идентификатор пользователя |
| login |
Логин пользователя |
| fio |
ФИО пользователя |
| description |
Дополнительная информация о пользователе |
| country |
Страна пользователя |
| city |
Город пользователя |
| online |
Онлайн статус пользователя (1 - онлайн, 0 - оффлайн) |
| regdate |
Дата регистрации пользователя, unixtime |
| rate |
Рейтинг пользователя |
getBW - Функция возвращает список пользователей, находящихся в черном и белом списке текущего пользователя.
$client->users()->getBW($count, $from, $id_group, $type);
Входные параметры
| Параметр |
Тип |
Описание |
| count |
int |
Число пользователей для выборке, не более 100 за запрос (по умолчанию) |
| from |
int |
Смещение от последней записи в выборке, по умолчанию 0 |
| id_group |
int |
Идентификатор группы БС/ЧС, если не определен, то выборка по параметру type |
| type |
string |
Тип списка (whiteList - белый список, blackList - черный), по умолчанию все вместе |
Результат
| Параметр |
Описание |
| id_user |
Идентификатор пользователя |
| id_group |
Идентификатор группы списка |
| login |
Логин пользователя |
| fio |
ФИО пользователя |
| online |
Онлайн-статус пользователя (1 - онлайн, 0 - оффлайн) |
| type |
Тип списка (whiteList - белый список, blackList - черный) |
getNote - Функция возвращает примечание к указанному пользователю.
$client->users()->getNote($id);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор пользователя, обязательный параметр |
Результат
| Параметр |
Описание |
| id_user |
Идентификатор пользователя |
| text |
Текст примечания |
| date |
Дата последнего изменения примечания, unixtime |
getUser - Функция возвращает подробную информацию об указанном пользователе.
$client->users()->getUser($id, $login);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор пользователя, полуобязательный параметр, имеет приоритет над параметром login |
| login |
string |
Логин пользователя, полуобязательный параметр, может указываться при отсутствии параметра id |
Результат
| Параметр |
Описание |
| id_user |
Идентификатор пользователя |
| login |
Логин пользователя |
| fio |
ФИО пользователя |
| description |
Дополнительная информация о пользователе |
| country |
Страна пользователя |
| city |
Город пользователя |
| online |
Онлайн-статус пользователя (1 - онлайн, 0 - оффлайн) |
| regdate |
Дата регистрации пользователя, unixtime |
| rate |
Рейтинг пользователя |
| photo |
Путь до аватара пользователя |
| group |
Название группы пользователя |
| works |
Виды указанных пользователем работ, только для исполнителя |
| categories |
Категории, указанные пользователем, только для исполнителя |
| langs |
Языки, указанные пользователем, только для исполнителя |
| portfolio |
Число работ в портфолио, только для исполнителя |
getWorks - Функция возвращает виды работ и минимальные цены исполнителя по ним.
$client->users()->getWorks($id);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор пользователя (исполнителя), обязательный параметр |
Результат
| Параметр |
Описание |
| works |
Массив ассоциативных пар значений [id_type => вид работы (1 - копирайтинг, 2 - рерайтинг, 3 - перевод, 4 - SEO копирайтинг), minprice => минимальная цена исполнителя (0 - цена не ограничена)]. Ключ элемента совпадает с id_type. |
getReports - Функция возвращает отзывы указанного незаблокированного пользователя. Отзывы разделены на два массива - negative (отрицательные отзывы) и positive (положительные) и сгруппированы по авторам.
$client->users()->getReports($id);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор пользователя, обязательный параметр |
Результат
| Параметр |
Описание |
| id_author |
Идентификатор автора отзыва |
| text |
Текст отзыва |
| date |
Дата отзыва, unixtime |
setReport - Функция добавляет/редактирует отзыв пользователю.
$client->users()->setReport($config);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор пользователя, кому отзыв |
| id |
int |
Идентификатор пользователя, кому отзыв |
| id_report |
int |
Идентификатор редактируемого отзыва, время для редактирования - 1 час от начала публикации |
| text |
string |
Текст отзыва, 50-5000 символов |
| rate |
int |
Тип отзыва: 1 - положительный (по умолчанию), 2 - отрицательный |
Результат
| Параметр |
Описание |
| id_report |
Идентификатор созданного/измененного отзыва |
getUserBW - Функция возвращает количество белых и черных списков, в которых находится пользователь.
$client->users()->getUserBW($id);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор пользователя, обязательный параметр |
Результат
| Параметр |
Описание |
| id_user |
Идентификатор пользователя, у которого считаем (повторяет входящий параметр) |
| whiteList |
Число пользователей, у которых запрашиваемый пользователь в белом списке |
| blackList |
Число пользователей, у которых запрашиваемый пользователь в черном списке |
setUserBW - Функция добавляет или удаляет пользователя в черный/белый список.
$client->users()->setUserBW($id, $id_group, $type);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор добавляемого/удаляемого пользователя, обязательный параметр |
| id_group |
int |
Идентификатор группы БС/ЧС, если не определен, то "без группы" |
| type |
string |
Тип действия: whiteList - в белый список, blackList - в черный, delete - удалить из списка |
Результат
| Параметр |
Описание |
| id |
Идентификатор пользователя, над которым производим действие (повторяет входящий параметр) |
| type |
Название выполненного действия |
getBalance - Функция возвращает состояние лицевого счета текущего пользователя.
$client->users()->getBalance();
Результат
| Параметр |
Описание |
| id |
Идентификатор текущего пользователя |
| balance |
Доступная сумма в рублях на лицевом счета |
| date |
Текущая дата запроса |
Функция возвращает список заказов текущего пользователя, только для заказчика
$client->tasks();
Доступные методы
listTasks - Возвращает список заказов текущего пользователя, только для заказчика.
$client->tasks()->listTasks($config);
Входные параметры
| Параметр |
Тип |
Описание |
| count |
int |
Число пользователей для выборки, не более 100 за запрос (по умолчанию) |
| from |
int |
Смещение от последней записи в выборке, по умолчанию 0 |
| id |
int |
Идентификатор конкретного заказа, будет возвращен только этот заказ |
| id_user |
int |
Идентификатор исполнителя заказа, при указании этого параметра будет фильтрация заказов по данному полю |
| id_folder |
int |
Идентификатор папки проекта (фильтрация по папке) |
| status |
int |
Фильтрация по статусу заказа, по умолчанию все заказы. Если указан статус "1", то дополнительно накладывается выдача только публикуемых заказов (не черновиков!) Значения: 1 - ожидание выбора исполнителя 2 - принят к исполнению 3 - на проверке 4 - выполнен 5 - просрочен |
| filter |
int |
Флаг общей фильтрации, по умолчанию все заказы. Исключает фильтрацию по статусу (если указан корректный параметр filter, то параметр status игнорируется) Значения: 10 - просроченные заказы в работе, по которым не принято решение |
| target |
int |
Фильтрация по уровню доступа заказа для исполнителя Значения: 1 - Общий заказ 2 - Заказ для белого списка 3 - Индивидуальный заказ |
| only_id |
int |
Если флаг указан и имеет значение 1, то будут возвращены только id заказов, а не вся информация. Параметр необязательный. |
Результат
| Параметр |
Описание |
| id |
Идентификатор заказа |
| id_user |
Идентификатор исполнителя, если не назначен, то значение 0 |
| id_folder |
Идентификатор папки |
| id_category |
Идентификатор категории |
| date |
Дата создания/редактирования заказа, unixtime |
| end_date |
Дата принятия заказа, unixtime, если не принят, то 0 |
| title |
Название заказа |
| description |
Описание заказа |
| id_type |
Тип заказа (1 - копирайтинг, 2 - рерайтинг, 3 - перевод, 4 - SEO копирайтинг) |
| id_subtype |
Тип текста (0 - не указан, 1 - продающий текст, 2 - информационная статья, 3 - новость/пресс-релиз, 4 - текст для email-рассылки, 5 - текст для соцсетей, 6 - отзыв) |
| id_level |
Уровень сложности заказа (0 - без квалификации, 1 - начальный уровень, 2 - средний уровень, 3 - высокий уровень) |
| deadline |
Срок сдачи заказа, unixtime |
| status |
Статус заказа (1 - ожидание выбора исполнителя, 2 - принят к исполнению, 3 - на проверке, 4 - выполнен, 5 - просрочен) |
| public |
Флаг публикации заказа (1 - публикуется, 0 - нет) |
| price |
Полная цена заказа, вне зависимости от типа цены |
| price_type |
Тип цены заказа (1 - за 1000 символов, 2 - за весь заказ) |
| size |
Размер заказа в символах |
| whitespaces |
Флаг учета пробелов (0 - без пробелов, 1 - с пробелами) |
| checksize |
Флаг проверки объема результата при сдаче (требование не менее 90%) - (0 - не проверять, 1 - проверять) |
| text |
Текст заказа |
| quick |
Флаг срочности заказа (1 - срочный, 0 - не срочный) |
| uniq |
Требование уникальности результата для автоматической отправки на доработку, если поле отсутствует, то параметр в заказе не указан |
| target |
Флаг уровня доступа заказа для исполнителя |
| id_target |
Идентификатор пользователя в случае индивидуального заказа, если поле отсутствует, то заказ не индивидуальный |
| keywords |
Список ключевых слов при типе задания "СЕО-копирайтинг" |
| language_fromlanguage_to |
Идентификаторы языков переводов при типе задания "Перевод" |
| multitask |
Флаг, является ли заказ мультизаказом (1 - да, 0 - во всех остальных случаях) |
| multicount |
Число оставшихся заказов при мультизаказе (которые можно создать при принятии заявки от исполнителя на мультизаказ), при достижении 0 мультизаказ автоматически снимается с публикации |
| filename |
Адрес вложенного в заказ файла, если его нет, то поле отсутствует |
viewNotes - Функция возвращает список заявок и комментариев на указанный заказ (или список заказов) текущего пользователя, только для заказчика.
$client->tasks()->viewNotes($id);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
int (array) |
Идентификатор заказа (-ов, но не более 100), обязательный параметр |
Результат
| Параметр |
Описание |
| id |
Идентификатор комментария |
| text |
Текст заявки |
| date |
Дата заявки, unixtime |
| id_user |
Идентификатор автора комментария/заявки |
| login |
Логин автора комментария/заявки |
| id_note |
Идентификатор заявки, если заявка отсутствует, то есть запись - просто комментарий, то значение поля 0 |
| id_task |
Идентификатор заказа |
viewNotesAll - Функция возвращает список всех поданных заявок на все заказы текущего заказчика.
$client->tasks()->viewNotesAll();
Результат
| Параметр |
Описание |
| id_note |
Идентификатор заявки |
| title |
Название заказа |
| price |
Цена заказа |
| deadline |
Срок сдачи заказа, unixtime |
| id_task |
Идентификатор заказа |
| id_user |
Идентификатор исполнителя |
| user |
Логин исполнителя |
| date |
Дата заявки, unixtime |
| text |
Текст заявки |
setNote - Функция принятия указанной заявки на заказ, только для заказчика.
$client->tasks()->setNote($id, $comment);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор заявки (не комментария!), обязательный параметр |
| comment |
string |
Комментарий при принятии заявки, добавляется в конец описания заказа, не более 500 символов |
Результат
| Параметр |
Описание |
| id_task |
Идентификатор заказа, если заявка принадлежит мультизаказу, то индентификатор нового созданного заказа, иначе того, на который заявка принята |
| id_user |
Идентификатор пользователя, назначенного исполнителем по принятой заявке |
unsetNote - Функция отклонения указанной заявки на заказ, только для заказчика.
$client->tasks()->unsetNote($id);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор заявки (не комментария!), обязательный параметр |
Результат
| Параметр |
Описание |
| id_task |
Идентификатор заказа, которому принадлежит отклоненная заявка |
| id_user |
Идентификатор пользователя, заявку которого отклонили |
paidTask - Функция принятия заказа на проверке, только для заказчика.
$client->tasks()->paidTask($id);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
array (int var1, int var2, ... ) |
Массив идентификаторов принимаемых заказов вида id[]=1&id[]=2, обязательный параметр |
Результат
| Параметр |
Описание |
| status |
Флаг успешности принятия |
| ids |
Массив идентификаторов принятых заказов |
cancelTask - Функция отправки заказа на проверке на доработку, только для заказчика.
$client->tasks()->cancelTask($id, $text);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
array (int var1, int var2, ... ) |
Массив идентификаторов отклоняемых заказов вида id[]=1&id[]=2, обязательный параметр |
| text |
string |
Комментарий к отклонению, обязателен, если отклоняется 1 заказ, а не пакет заказов, иначе обнуляется |
Результат
| Параметр |
Описание |
| status |
Флаг успешности принятия |
| ids |
Массив идентификаторов отклоненных заказов |
getResults - Функция получения результатов по заказам, только для заказчика.
$client->tasks()->getResults($id);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
array (int var1, int var2, ...) |
Массив идентификаторов заказов, обязательный параметр |
Результат
| Параметр |
Описание |
| id |
Идентификатор результата |
| id_task |
Идентификатор заказа |
| id_user |
Идентификатор пользователя, сдавшего результат |
| comment |
Комментарий пользователя к сдаче результата |
| date |
Дата сдачи результата, unixtime |
| date_reset |
Дата отправки результата на доработку, unixtime |
| status |
Статус результата (0 - на проверке, 1 - отклонен, 2 - принят) |
| check |
Флаг проверки результата системой (0 - не проверено, 1 - проверено) |
| files |
Массив файлов результата, ссылки на файлы действительны примерно сутки |
| per_keywords |
Процент вхождения указанных ключевых слов, только для типа заказов SEO-копирайтинг |
| per_mistakes |
Процент орфографических ошибок после проверки системой по внутреннему словарю |
| per_antiplagiat |
Процент уникальности текста |
| per_diff |
Процент схожести с исходником, только для типа заказов рерайтинг и при приложенном исходном тексте |
| auto_check_date |
Дата проверки результата системой, unixtime |
| name |
Тип приложенного документа |
| size |
Размер приложенного файла |
| path |
Путь для скачивания результата, действительно примерно сутки с момента осуществления запроса |
deleteTask - Функция удаления заказов в статусе ожидания исполнителя или из черновика, только для заказчика. Запрещено удалять заказы в течение недели после снятия исполнителя с заказа.
$client->tasks()->deleteTask($id);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
array (int var1, int var2, ...) |
Массив идентификаторов заказов, обязательный параметр |
Результат
| Параметр |
Описание |
| ids |
Массив идентификаторов удаленных заданий |
extraPaid - Функция начисления доплаты по заданию.
$client->tasks()->extraPaid($id, $count, $note, $autopay);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор задания |
| count |
int |
Сумма доплаты, не более стоимости заказа * 3 |
| note |
int |
Посылать уведомление исполнителю, по умолчанию 1 (1 - да, 0 - нет) |
| autopay |
string |
Расчет доплаты автоматически, по числу превышения знаков у последнего результата (get - получить расчет доплаты, pay - произвести доплату), по умолчанию размер доплаты берется из параметра count |
Результат
| Параметр |
Описание |
| status |
Флаг успешности зачисления |
| count |
Размер доплаты. Возвращается если установлен параметр autopay=get |
saveTask - Функция добавления/редактирования заказа, только для заказчика.
$client->tasks()->saveTask($config);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор редактируемого заказа, если не указан, то заказ будет создан новый |
| public |
int |
Флаг публикации заказа (0 - не публикуется, 1 - публикуется) |
| title |
string |
Название заказа, не более 512 символов, обязательный параметр |
| description |
string |
Описание заказа, не более 5000 символов |
| text |
string |
Текст заказа, не более 40000 символов |
| price |
int |
Цена заказа, обязательный параметр |
| price_type |
int |
Тип цены заказа (1 - за 1000 знаков, 2 - за весь заказ) |
| uniq |
int |
Требуемая уникальность заказа, по умолчанию не определена |
| whitespaces |
int |
Флаг с учетом пробелов или нет (0 - без пробелов, 1 - с пробелами) |
| only_stars |
int |
Флаг учета уровня мастерства исполнителя (0 - без учета, 1 - с учетом) |
| size |
int |
Размер заказа в символах, обязательный параметр при отсутствии параметра text |
| checksize |
int |
Флаг учета минимального размера результата сдачи в 90% (1 - включено и тексты менее 90% от размера заказа приниматься не будут, 0 - выключено) |
| id_type |
int |
Идентификатор типа заказа, по умолчанию 1 (копирайтинг) |
| id_subtype |
int |
Тип текста, необязательный параметр (0 по умолчанию). Значения: 1 - продающий текст, 2 - информационная статья, 3 - новость/пресс-релиз, 4 - текст для email-рассылки, 5 - текст для соцсетей, 6 - отзыв |
| deadline |
string |
Срок сдачи заказа в формате дд.мм.гггг, не более 90 дней |
| timeline |
string |
Время сдачи заказа в формате чч:мм |
| auto_work |
int |
Флаг автопринятия заявки в заказе (1 - автопринятие, 0 - нет) |
| auto_rate |
int |
Рейтинг для автопринятия заказа, по умолчанию 0 |
| auto_reports |
int |
Число положительных отзывов для автопринятия заказа (не менее), 0 по умолчанию |
| auto_reports_n |
int |
Число отрицательных отзывов для автопринятия заказа (не более), по умолчанию параметр отсутствует, может быть 0 |
| auto_level |
int |
Идентификатор уровня мастерства исполнителя для автопринятия заказа, по умолчанию 0 (без квалификации) |
| id_category |
int |
Идентификатор категории заказа, обязательное поле |
| multitask |
int |
Флаг мультизаказа (1 - мультизаказ, 0 - обычный) |
| multicount |
int |
Число мультизаказов |
| id_folder |
int |
Идентификатор папки заказа |
| target_task |
int |
Флаг доступности заказа (1 - для всех, 2 - для белого списка, 3 - индивидуальный заказ) |
| id_target |
int |
Идентификатор пользователя, для кого выставлен индивидуальный заказ, или группы БС - если заказ выставляется для конкретной группы |
| keywords |
string |
Список ключевых слов через запятую для типа заказа SEO-копирайтинг (4) |
| language_from |
int |
Идентификатор языка, откуда осуществлять перевод, для типа заказа по переводу (3) |
| language_to |
int |
Идентификатор языка, на который осуществлять перевод, для типа заказа по переводу (3) |
| bwgroup_send |
int |
Флаг (1 - посылать, 0 или не указан - не посылать), посылать ли уведомление группе из БС о выставлении для них заказа (параметры target_task = 2, id_target = ИД группы БС) |
| file |
file |
Прилагаемый файл заказа |
Результат
| Параметр |
Описание |
| id_tasks |
Идентификатор созданного или отредактированного заказа |
failTask - Функция отмены просроченного заказа, только для заказчика. Отмененный заказ невозможно удалить, он будет существовать для истории 2 недели, после чего удалится автоматически.
$client->tasks()->failTask($id, $copy, $deadline, $timeline);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор просроченного заказа, обязательный параметр |
| copy |
int |
Флаг создания копии отменяемого заказа, если указано и значение 1, то создастся публикуемая копия заказа со сроком, задаваемым параметрами ниже |
| deadline |
string |
Новый срок сдачи в формате дд.мм.гггг, по умолчанию - текущее время плюс 5 суток для несрочного заказа или 5 часов для срочного |
| timeline |
string |
Новое время сдачи в формате чч:мм, 23:59 по умолчанию |
Результат
| Параметр |
Описание |
| id |
Идентификатор отмененного заказа |
| id_copy |
Идентификатор созданной копии заказа, если указано копирование |
| rateup |
Ссылка для восстановления рейтинга исполнителю |
copyTask - Функция копирования заказа, только для заказчика. Новый заказ будет публикуемым и доступный исполнителям, настройки автопринятия и мультизаказа не копируются.
$client->tasks()->copyTask($id, $deadline, $timeline);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор копируемого заказа, обязательный параметр |
| deadline |
string |
Новый срок сдачи в формате дд.мм.гггг, не более 90 дней, по умолчанию или если некорректное - текущее время плюс 5 суток для несрочного заказа или 5 часов для срочного |
| timeline |
string |
Новое время сдачи в формате чч:мм, 23:59 по умолчанию |
Результат
| Параметр |
Описание |
| id_copy |
Идентификатор созданной копии заказа |
setDeadline - Функция увеличения срока сдачи заказа, только для заказчика. Если заказ просроченный, то он будет возвращен в работу, если в черновике, то возможна его публикации для ожидания подачи заявок.
$client->tasks()->setDeadline($id, $deadline, $timeline, $public);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор заказа, обязательный параметр |
| deadline |
string |
Новый срок сдачи заказа в формате дд.мм.гггг (25.10.2013), должен быть не меньше текущего, но не более 90 дней, обязательный параметр. |
| timeline |
string |
Новое время сдачи заказа в формате чч:мм (12:16), если не указано, то будет 23:59, необязательный параметр |
| public |
int |
Флаг публикации черновика, если 1, то заказ-черновик будет опубликован, иначе статус публикации не изменится |
Результат
| Параметр |
Описание |
| deadline |
Установленная дата и время сдачи заказа |
| id |
Идентификатор заказа |
| status |
Текущий статус заказа (например, был 5 - просроченный, после продления станет 2 - в работе) |
| quick |
Флаг срочности заказа, 1 - срочный, 0 - нет |
saveComment - Функция добавления комментария в заказ, только для заказчика или назначенного исполнителя.
$client->tasks()->saveComment($id, $text, $hide);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор заказа, обязательный параметр |
| text |
string |
Текст комментария, максимум 2048 символов, обязательный параметр. |
| hide |
int |
Флаг скрытия текста комментария (1 - скрывать, 0 или отсутствует - не скрывать), необязательный параметр |
Результат
| Параметр |
Описание |
| id |
Идентификатор заказа |
| id_comment |
Идентификатор добавленного комментария |
| comments |
Число комментариев в заказе |
sendNoteFail - Функция создает заявку в обратную связь на снятие исполнителя с заказа.
$client->tasks()->sendNoteFail($id, $text);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор заказа, с которого снимать исполнителя, заказ должен быть в статусе "На проверке" и текущий исполнитель должен иметь хоть один сданный результат. |
| text |
string |
Текст заявки на снятие, причины, недочеты. |
Результат
| Параметр |
Описание |
| status |
Флаг успешного создания заявки |
| ticket |
Ссылка на созданный тикет в обратную связь |
Функция получения списка заказов из архива заказов, только для заказчика
$client->tasksArchive();
Доступные методы
listTasks - Возвращает список архивных заказов текущего пользователя, только для заказчика.
$client->tasksArchive()->listTasks($config);
Входные параметры
| Параметр |
Тип |
Описание |
| count |
int |
Число пользователей для выборке, не более 100 за запрос (по умолчанию) |
| from |
int |
Смещение от последней записи в выборке, по умолчанию 0 |
| order |
string |
Порядок сортировки, возможные значения: desc, asc (по умолчанию) |
| id |
int |
Идентификатор конкретного заказа, будет возвращен только этот заказ |
| id_folder |
int |
Идентификатор папки проекта (фильтрация по папке) |
| id_user |
int |
Идентификатор исполнителя заказа, при указании этого параметра будет фильтрация заказов по данному полю |
Результат
| Параметр |
Описание |
| id |
Идентификатор заказа |
| id_user |
Идентификатор исполнителя, если не назначен, то значение 0 |
| id_folder |
Идентификатор папки |
| id_category |
Идентификатор категории |
| date |
Дата создания/редактирования заказа, unixtime |
| title |
Название заказа |
| description |
Описание заказа |
| id_type |
Тип заказа (1 - копирайтинг, 2 - рерайтинг, 3 - перевод, 4 - SEO копирайтинг) |
| id_level |
Уровень сложности заказа (0 - без квалификации, 1 - начальный уровень, 2 - средний уровень, 3 - высокий уровень) |
| deadline |
Срок сдачи заказа, unixtime |
| price |
Цена заказа |
| price_type |
Тип цены заказа (1 - за 1000 символов, 2 - за весь заказ) |
| size |
Размер заказа в символах |
| whitespaces |
Флаг учета пробелов (0 - без пробелов, 1 - с пробелами) |
| text |
Текст заказа |
| end_date |
Дата окончания (принятия) заказа, unixtime |
| date_archive |
Дата переноса заказа в архив, unixtime |
| keywords |
Список ключевых слов при типе задания "СЕО-копирайтинг" |
| language_fromlanguage_to |
Языки переводов при типе задания "Перевод" |
getResults - Функция получения результатов по архивному заказу, только для заказчика.
$client->tasksArchive()->getResults($id);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор заказа, обязательный параметр |
Результат
| Параметр |
Описание |
| id_task |
Идентификатор заказа |
| id_user |
Идентификатор пользователя, сдавшего результат |
| comment |
Комментарий пользователя к сдаче результата |
| content |
Текст результата |
| date |
Дата сдачи результата, unixtime |
| date_reset |
Дата отправки результата на доработку, unixtime |
| check |
Массив параметров проверки результата системой |
| files |
Массив файлов результата, ссылки на файлы действительны примерно сутки |
Функция получения списка языков, используемых в системе
$client->options();
Доступные методы
getLangs - Функция получения списка языков, используемых в системе.
$client->options()->getLangs();
Результат
| Параметр |
Описание |
| id |
Идентификатор статьи |
| title |
Название статьи |
| description |
Закодированная в base64 картинка описания статьи (формат картинки png) |
| keywords |
Ключевые слова статьи |
| date |
Дата добавления статьи, unixtime |
| date_buy |
Дата покупки статьи, unixtime (только для купленной, при filter=1) |
| id_type |
Идентификатор типа текста статьи |
| id_subtype |
Идентификатор типа статьи (1 - общая статья, 2 - новость, 3 - описание товара для интернет-магазина, 4 - обзор товара, 5 - кулинарный рецепт, 6 - мастер-классы (рукоделие, поделки и проч.), 7 - пресс-релиз, 8 - эссе, 9 - статья для главной страницы сайта, 10 - лирика (стихотворение)) |
| id_folder |
Идентификатор папки купленной статьи |
| id_category |
Идентификатор категории статьи |
| id_language |
Идентификатор языка текста статьи |
| full_price |
Цена статьи, включая комиссию для покупателя (с учетом возможной скидки) |
| discount |
Размер скиди для статьи в процентах |
| date_discount |
Дата до которой действует скидка (включительно) |
| size |
Число символов в статье |
| images |
Число изображений в статье |
| unq |
Уникальность статьи в % (проверка на рерайтинг и проверка на копии) |
| unq_shin |
Уникальность статьи в % (проверка на рерайтинг и проверка на копии) |
| moder_check |
Флаг проверки статьи (авто)модератором на качество |
| moder_orph |
Оценка орфографии (1 - без ощибок, 0 - с ошибками) |
| moder_punc |
Оценка пунктуации и грамматики (1 - без ощибок, 0 - с ошибками) |
| moder_style |
Оценка стилистики (1 - без ощибок, 0 - с ошибками) |
Функция получения списка готовых статей на продажу
$client->articles();
Доступные методы
getList - Возвращает список готовых статей на продажу. Поле "Описание статьи" не выводится во избежание автоматической выемки всех описаний статей.
$client->articles()->getList($config);
Входные параметры
| Параметр |
Тип |
Описание |
| count |
int |
Число статей для выборке, не более 20 за запрос (по умолчанию) |
| from |
int |
Смещение от последней записи в выборке, по умолчанию 0 |
| id_user |
int |
Идентификатор автора статьи для фильтрации списка |
| id_category |
int |
Идентификатор категории статьи для фильтрации списка |
| subcat |
int |
Опция поиска в подкатегориях (1 - искать в подкатегориях, 0 - нет, по умолчанию) |
| id_subtype |
int |
Идентификатор типа статьи для фильтрации списка (от 1 до 10) |
| filter |
int |
Флаг показа купленных статей текущим пользователем, если указано 1, то будут выбраны только купленные статьи текущим пользователем, иначе только статьи на продажу |
| id |
int |
Идентификатор статьи: будет выбрана только указанная статья |
| text |
string (40) |
Строка для поиска по названию, описанию и ключевым словам |
| price_from |
int |
Фильтрация по цене, от ... до, если указан параметр price_type (любое значение), то поиск по цене за 1000 знаков |
| price_to |
int |
Фильтрация по цене, от ... до, если указан параметр price_type (любое значение), то поиск по цене за 1000 знаков |
| price_type |
int |
Фильтрация по цене, от ... до, если указан параметр price_type (любое значение), то поиск по цене за 1000 знаков |
| size_from |
int |
Фильтрация по размеру текста, от ... до |
| size_to |
int |
Фильтрация по размеру текста, от ... до |
| uniq_from |
int |
Фильтрация по уникальности статьи, от ... до |
| uniq_to |
int |
Фильтрация по уникальности статьи, от ... до |
| id_language |
int |
Фильтрация по языку статьи, список идентификаторов options.getLangs, если 0 или ошибочен, то без учета параметра |
| sort |
string |
Сортировка статей, значения: relevancy (по релевантности при поиске по тексту), title (по названию), price (по цене), size (по размеру), uniq (по уникальности), date (по дате добавления - по умолчанию) |
| order |
string |
Порядок сортировки статей, только при заданном параметре sort, значения: desc (по убыванию), asc (по возрастанию) |
Результат
| Параметр |
Описание |
| id |
Идентификатор статьи |
| title |
Название статьи |
| description |
Закодированная в base64 картинка описания статьи (формат картинки png) |
| keywords |
Ключевые слова статьи |
| date |
Дата добавления статьи, unixtime |
| date_buy |
Дата покупки статьи, unixtime (только для купленной, при filter=1) |
| id_type |
Идентификатор типа текста статьи |
| id_subtype |
Идентификатор типа статьи (1 - общая статья, 2 - новость, 3 - описание товара для интернет-магазина, 4 - обзор товара, 5 - кулинарный рецепт, 6 - мастер-классы (рукоделие, поделки и проч.), 7 - пресс-релиз, 8 - эссе, 9 - статья для главной страницы сайта, 10 - лирика (стихотворение)) |
| id_folder |
Идентификатор папки купленной статьи |
| id_category |
Идентификатор категории статьи |
| id_language |
Идентификатор языка текста статьи |
| full_price |
Цена статьи, включая комиссию для покупателя (с учетом возможной скидки) |
| discount |
Размер скиди для статьи в процентах |
| date_discount |
Дата до которой действует скидка (включительно) |
| size |
Число символов в статье |
| images |
Число изображений в статье |
| unq |
Уникальность статьи в % (проверка на рерайтинг и проверка на копии) |
| unq_shin |
Уникальность статьи в % (проверка на рерайтинг и проверка на копии) |
| moder_check |
Флаг проверки статьи (авто)модератором на качество |
| moder_orph |
Оценка орфографии (1 - без ощибок, 0 - с ошибками) |
| moder_punc |
Оценка пунктуации и грамматики (1 - без ощибок, 0 - с ошибками) |
| moder_style |
Оценка стилистики (1 - без ощибок, 0 - с ошибками) |
buy - Функция осуществляет покупку указанной статьи текущим пользователем
$client->articles()->buy($id);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор покупаемой статьи |
Результат
| Параметр |
Описание |
| id |
Идентификатор купленной статьи |
getText - Функция выводит тексты запрошенных купленных статей
$client->articles()->getText($id);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
array (int var1, int var2, ...) |
Массив идентификаторов купленных статей |
Результат
| Параметр |
Описание |
| id |
Идентификатор купленной статьи |
| title |
Название купленной статьи |
| description |
Описание статьи |
| text |
Текст купленной статьи |
download - Функция создает zip архив с текстами и изображениями указанных купленных статей для текущего пользователя
$client->articles()->download($id);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
array (int var1, int var2, ...) |
Массив идентификаторов купленных статей |
Результат
| Параметр |
Описание |
| path |
Путь для скачивания ZIP архива |
Возвращает список купленных пользователм статей и перенесенных в архив статей
$client->articlesArchive();
Доступные методы
getList - Возвращает список купленных пользователм статей и перенесенных в архив статей.
$client->articlesArchive()->getList($config);
Входные параметры
| Параметр |
Тип |
Описание |
| count |
int |
Число статей для выборке, не более 20 за запрос (по умолчанию) |
| from |
int |
Смещение от последней записи в выборке, по умолчанию 0 |
| id_user |
int |
Идентификатор автора статьи для фильтрации списка |
| id_subtype |
int |
Идентификатор типа статьи для фильтрации списка (от 1 до 10) |
| order |
string |
Порядок сортировки, возможные значения: desc, asc (по умолчанию) |
| id_category |
int |
Идентификатор категории статьи для фильтрации списка |
| subcat |
int |
Опция поиска в подкатегориях (1 - искать в подкатегориях, 0 - нет, по умолчанию) |
| text |
string (40) |
Строка для поиска по названию, описанию и ключевым словам |
Результат
| Параметр |
Описание |
| id |
Идентификатор статьи |
| title |
Название статьи |
| description |
Описание статьи |
| keywords |
Ключевые слова статьи |
| date |
Дата добавления статьи, unixtime |
| id_type |
Идентификатор типа текста статьи |
| id_subtype |
Идентификатор типа статьи |
| id_category |
Идентификатор категории статьи |
| id_language |
Идентификатор языка текста статьи |
| full_price |
Цена статьи, включая комиссию для покупателя |
| size |
Число символов в статье |
| images |
Число изображений в статье |
| quality |
Массив качественных оценок статьи, если она была проверена (авто) модератором |
getText - Функция выводит тексты запрошенных статей из архива текущего пользователя
$client->articlesArchive()->getText($id);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
array (int var1, int var2, ...) |
Массив идентификаторов статей в архиве |
Результат
| Параметр |
Описание |
| id |
Идентификатор статьи |
| title |
Название статьи |
| description |
Описание статьи |
| text |
Текст статьи |
download - Функция создает zip архив с текстами и изображениями указанных статей из архива для текущего пользователя
$client->articlesArchive()->download($id);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
array (int var1, int var2, ...) |
Массив идентификаторов статей из архива |
Результат
| Параметр |
Описание |
| path |
Путь для скачивания ZIP архива |
Функция возвращает список групп для БС/ЧС текущего пользователя
$client->bwgroups();
Доступные методы
listGroups - Функция возвращает список групп для БС/ЧС текущего пользователя.
$client->bwgroups()->listGroups();
Результат
| Параметр |
Описание |
| id_category |
Идентификатор группы |
| id_parent |
Идентификатор родительской группы |
| name |
Название группы |
| depth |
Глубина вложенности группы |
| last |
Флаг, является ли группа последней по глубине вложенности |
saveGroup - Функция добавляет или изменяет группу для БС/ЧС текущего пользователя.
$client->bwgroups()->saveGroup($name, $id, $id_parent);
Входные параметры
| Параметр |
Тип |
Описание |
| name |
string |
Название группы, до 40 символов |
| id |
int |
Идентификатор редактируемой группы, если не указан, будет создана новая |
| id_parent |
int |
Идентификатор родительской категории, по умолчанию 0 - корень |
Результат
| Параметр |
Описание |
| id |
Идентификатор созданной или отредактированной группы |
deleteGroup - Функция удаляет группу для БС/ЧС и все ее подгруппы текущего пользователя.
$client->bwgroups()->deleteGroup($id);
Входные параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор удаляемой группы |
Результат
| Параметр |
Описание |
| ids |
Массив идентификаторов удаленных групп |
updateGroup - Функция перемещает пользователя, уже занесенного в БС/ЧС, в указанную группу текущего пользователя.
$client->bwgroups()->updateGroup($id_user, $id_group);
Входные параметры
| Параметр |
Тип |
Описание |
| id_user |
int |
Идентификатор пользователя, уже внесенного в БС/ЧС, для переноса в другую группу |
| id_group |
int |
Идентификатор группы для переноса, если 0 или не указана, то считается как "без группы" |
Результат
| Параметр |
Описание |
| id_user |
Идентификатор перенесенного пользователя |
| id_group |
Идентификатор группы, куда перенесен пользователь |
| name |
Название группы, куда перенесе пользователь, если пустая строка, значит пользователь удален из всех групп |
Функция выводит непрочитанные системные сообщения пользователя
$client->messages();
Доступные методы
getList - Функция выводит непрочитанные системные сообщения пользователя. Максимальный лимит сообщений 100.
$client->messages()->getList($from);
Входные параметры
| Параметр |
Тип |
Описание |
| from |
int |
Дата, с которой выводить сообщения, unixtime |
Результат
| Параметр |
Описание |
| id |
Идентификатор сообщения |
| date |
Дата сообщения, unixtime |
| text |
Текст сообщения, может содержать HTML или BB форматирование |
setRead - Функция помечает указанные непрочитанные системные сообщения пользователя как прочитанные.
$client->messages()->setRead($ids);
Входные параметры
| Параметр |
Тип |
Описание |
| ids |
array (int var1, int var2, ...) |
Массив идентификаторов сообщений |
Результат
| Параметр |
Описание |
| ids |
Массив идентификаторов отмеченных сообщений |
setDelete - Функция удаляет указанные непрочитанные системные сообщения пользователя.
$client->messages()->setDelete($ids);
Входные параметры
| Параметр |
Тип |
Описание |
| ids |
array (int var1, int var2, ...) |
Массив идентификаторов сообщений |
Результат
| Параметр |
Описание |
| ids |
Массив идентификаторов удаленных сообщений |
readPrivate - Функция выводит сообщения из привата с указанным пользователем.
$client->messages()->readPrivate($config);
Входные параметры
| Параметр |
Тип |
Описание |
| id_user |
int |
Идентификатор пользователя, обязательный параметр |
| count |
int |
Число сообщений для выборки, максимально и по умолчанию 100 |
| from |
int |
Смещение, начиная с которого выбирать, по умолчанию 0 |
| date_from |
int |
Дата начала выборки, unixtime |
| date_to |
int |
Дата окончания выборки, unixtime |
| unread |
int |
Если указано 1, то выводятся только непрочитанные сообщения, показанные сообщения сразу пометятся как прочитанные |
Результат
| Параметр |
Описание |
| date |
Дата сообщения, unixtime |
| text |
Текст сообщения |
| id_author |
Идентификатор автора сообщения |
| id_user |
Идентификатор собеседника |
| reads |
Флаг прочтения сообщения, 1 - прочитано, 0 - не прочитано |
getCountUnread - Функция возвращает количество непрочитанных сообщений из привата, с группировкой по авторам.
$client->messages()->getCountUnread();
Результат
| Параметр |
Описание |
| count |
Общее количество непрочитанных сообщений |
| users |
Массив ассоциативных пар значений [id_author => идентификатор пользователя, count => количество непрочитанных сообщений] |
writePrivate - Функция посылает сообщение в приват указанному пользователем. Данная возможность доступна пользователям с рейтингом более 10000. Таймаут между сообщениями 1 минута.
$client->messages()->writePrivate($id_user, $text);
Входные параметры
| Параметр |
Тип |
Описание |
| id_user |
int |
Идентификатор пользователя, обязательный параметр |
| text |
string |
Текст сообщения, максимально 10000 символов |
Результат
| Параметр |
Описание |
| id_user |
Идентификатор пользователя, которому посылается сообщение |
| text |
Текст сообщения |
| time |
Время отсылки, unixtime |
Функция выводит список отказов от заказов для заказчика
$client->rating();
Доступные методы
listTasksFails - Функция выводит список отказов от заказов для заказчика.
$client->rating()->listTasksFails($id_task, $id_user, $back);
Входные параметры
| Параметр |
Тип |
Описание |
| id_task |
int |
Идентификатор конкретного заказа |
| id_user |
int |
Идентификатор конкретного исполнителя |
| back |
int |
Флаг фильтрации по статусу возврата (1 - с возвратом рейтинга, 2 - без возврата, 0 - все, по умолчанию) |
Результат
| Параметр |
Описание |
| id_task |
Идентификатор заказа |
| id_user |
Идентификатор исполнителя |
| date |
Дата отказа, unixtime |
| date_back |
Дата возврата рейтинга, unixtime |
| back |
Флаг возврата рейтинга |
| title |
Название заказа |
ratingUserBack - Функция возвращает рейтинг исполнителю по определенному отказу.
$client->rating()->ratingUserBack($id_task, $id_user);
Входные параметры
| Параметр |
Тип |
Описание |
| id_task |
int |
Идентификатор конкретного заказа |
| id_user |
int |
Идентификатор конкретного исполнителя |
Результат
| Параметр |
Описание |
| id_task |
Идентификатор заказа |
| id_user |
Идентификатор исполнителя |
| rate_back |
Количество возвращенного рейтинга исполнителю |
Функция показывает степень схожести двух текстов
$client->diff();
Доступные методы
compareText - Функция показывает степень схожести двух текстов
$client->diff()->compareText($source, $text);
Входные параметры
| Параметр |
Тип |
Описание |
| source |
string |
Исходный текст (длина от 30 до 20000 знаков) |
| text |
string |
Текст для сравнения (длина от 30 до 20000 знаков) |
Результат
| Параметр |
Описание |
| result |
Процент совпадений |
| text |
Результат сравнения для text |
| source |
Результат сравнения для source |
Функция создает задание на коррекцию текста
$client->correction();
Доступные методы
add - Функция создает задание на коррекцию.
$client->correction()->add($config);
Входные параметры
| Параметр |
Тип |
Описание |
| title |
string |
Заголовок задания, обязательный параметр |
| description |
string |
Описание задания |
| text |
string |
Проверяемый текст, обязательный параметр |
| id_folder |
int |
Идентификатор папки проекта задания, по умолчанию 0 |
| deadline |
string |
Дата проверки текста корректором в формате дд.мм.гггг, по умолчанию (минимально возможное) - текущее время плюс 1 сутки |
| timeline |
string |
Cрок проверки текста корректором в формате чч:мм, 23:59 по умолчанию |
Результат
| Параметр |
Описание |
| id |
Идентификатор добавленного задания |
import - Функция создает задание на коррецию из заказов и статей.
$client->correction()->import($config);
Входные параметры
| Параметр |
Тип |
Описание |
| type |
string |
Тип объекта ('task' - заказ, 'a_task' - заказ из архива, 'article' - купленная статья, 'a_article' - купленная статья из архива), обязательное поле |
| id_object |
int |
Идентификатор объекта, обязательное поле. Внимание, для типа объекта 'task' необходимо указывать идентификатор результата выполнения заказа (а не самого заказа))! |
| object_type |
string |
Подтип объекта, может принимать единственное значений 'file', что указывает на приоритет импорта вложения, а не текстового поля (например, при импорте из результата заказа, когда сдается вложение и просто текст в поле)). |
| deadline |
string |
Дата проверки текста корректором в формате дд.мм.гггг, по умолчанию (минимально возможное) - текущее время плюс 1 сутки |
| timeline |
string |
Cрок проверки текста корректором в формате чч:мм, 23:59 по умолчанию |
Результат
| Параметр |
Описание |
| id |
Идентификатор добавленного задания |
