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();

结果

该函数返回当前用户的文件夹列表

$client->folders();

可用方法

listFolders - 返回当前用户排序的文件夹列表。

$client->folders()->listFolders($sort);

输入参数

结果

addFolder - 为当前用户创建文件夹。

$client->folders()->addFolder($name, $id_parent);

输入参数

结果

moveToFolder - 函数将对象移动到文件夹。

$client->folders()->moveToFolder($id_folder, $type, $ids);

输入参数

结果

该函数返回执行者列表

$client->users();

可用方法

getList - 返回未排序的执行者列表。

$client->users()->getList($config);

输入参数

结果

getBW - 函数返回当前用户黑名单和白名单中的用户。

$client->users()->getBW($count, $from, $id_group, $type);

输入参数

结果

getNote - 函数返回指定用户的注释。

$client->users()->getNote($id);

输入参数

结果

getUser - 函数返回指定用户的详细信息。

$client->users()->getUser($id, $login);

输入参数

结果

getWorks - 函数返回执行者的工作类型及其最低价格。

$client->users()->getWorks($id);

输入参数

结果

getReports - 函数返回指定未封锁用户的评论。评论分为两个数组 - negative (负面评论) 和 positive (正面评论)，并按作者分组。

$client->users()->getReports($id);

输入参数

结果

setReport - 函数为用户添加/编辑评论。

$client->users()->setReport($config);

输入参数

结果

getUserBW - 函数返回用户在白名单和黑名单中的数量。

$client->users()->getUserBW($id);

输入参数

结果

setUserBW - 函数向黑名单/白名单添加或删除用户。

$client->users()->setUserBW($id, $id_group, $type);

输入参数

结果

getBalance - 函数返回当前用户的账户状态。

$client->users()->getBalance();

结果

该函数返回当前用户的订单列表，仅限客户

$client->tasks();

可用方法

listTasks - 返回当前用户的订单列表，仅限客户。

$client->tasks()->listTasks($config);

输入参数

结果

viewNotes - 函数返回当前用户指定订单（或订单列表）的申请和评论，仅限客户。

$client->tasks()->viewNotes($id);

输入参数

结果

viewNotesAll - 函数返回当前客户所有订单的所有申请。

$client->tasks()->viewNotesAll();

结果

setNote - 函数接受指定订单的申请，仅限客户。

$client->tasks()->setNote($id, $comment);

输入参数

结果

unsetNote - 函数拒绝指定订单的申请，仅限客户。

$client->tasks()->unsetNote($id);

输入参数

结果

paidTask - 函数接受待审查的订单，仅限客户。

$client->tasks()->paidTask($id);

输入参数

结果

cancelTask - 函数将订单发送回审查以进行修改，仅限客户。

$client->tasks()->cancelTask($id, $text);

输入参数

结果

getResults - 函数获取订单结果，仅限客户。

$client->tasks()->getResults($id);

输入参数

结果

deleteTask - 函数删除等待执行者或草稿状态下的订单，仅限客户。禁止在解除执行者后一周内删除订单。

$client->tasks()->deleteTask($id);

输入参数

结果

extraPaid - 函数按任务计发额外费用。

$client->tasks()->extraPaid($id, $count, $note, $autopay);

输入参数

结果

saveTask - 函数添加/编辑订单，仅限客户。

$client->tasks()->saveTask($config);

输入参数

结果

failTask - 函数取消逾期订单，仅限客户。取消的订单无法删除，它将在历史记录中存在2周，然后自动删除。

$client->tasks()->failTask($id, $copy, $deadline, $timeline);

输入参数

结果

copyTask - 函数复制订单，仅限客户。新订单将是公开的，可供执行者访问，不会复制自动接受和多订单设置。

$client->tasks()->copyTask($id, $deadline, $timeline);

输入参数

结果

setDeadline - 增加订单交货期限的函数，仅限客户使用。如果订单逾期，则将订单返回工作状态，如果处于草稿状态，则可能发布以等待申请。

$client->tasks()->setDeadline($id, $deadline, $timeline, $public);

输入参数

结果

saveComment - 在订单中添加评论的函数，仅限客户或指定执行者使用。

$client->tasks()->saveComment($id, $text, $hide);

输入参数

结果

sendNoteFail - 创建一个请求取消执行者的订单的反馈申请的函数。

$client->tasks()->sendNoteFail($id, $text);

输入参数

结果

仅限客户使用的从订单存档获取订单列表的函数。

$client->tasksArchive();

可用方法

listTasks - 返回当前用户存档订单列表，仅限客户使用。

$client->tasksArchive()->listTasks($config);

输入参数

结果

getResults - 获取存档订单结果的函数，仅限客户使用。

$client->tasksArchive()->getResults($id);

输入参数

结果

获取系统使用中语言的列表的函数。

$client->options();

可用方法

getLangs - 获取系统使用中语言的列表的函数。

$client->options()->getLangs();

结果

获取可供销售的成品文章列表的函数。

$client->articles();

可用方法

getList - 返回可供销售的成品文章列表。为避免自动提取所有文章描述，不显示“文章描述”字段。

$client->articles()->getList($config);

输入参数

结果

buy - 由当前用户进行的指定文章购买的函数。

$client->articles()->buy($id);

输入参数

结果

getText - 输出请求的已购买文章的文本。

$client->articles()->getText($id);

输入参数

结果

download - 为当前用户创建包含指定已购买文章文本和图像的zip存档。

$client->articles()->download($id);

输入参数

结果

返回用户已购买并移至存档的文章列表。

$client->articlesArchive();

可用方法

getList - 返回用户已购买并移至存档的文章列表。

$client->articlesArchive()->getList($config);

输入参数

结果

getText - 输出当前用户存档中请求的文章的文本。

$client->articlesArchive()->getText($id);

输入参数

结果

download - 为当前用户创建包含存档中指定文章文本和图像的zip存档。

$client->articlesArchive()->download($id);

输入参数

结果

返回当前用户的BS/CS（批量/常量）组列表的函数。

$client->bwgroups();

可用方法

listGroups - 返回当前用户的BS/CS组列表。

$client->bwgroups()->listGroups();

结果

saveGroup - 为当前用户的BS/CS添加或修改组的函数。

$client->bwgroups()->saveGroup($name, $id, $id_parent);

输入参数

结果

deleteGroup - 删除当前用户的BS/CS组及其所有子组的函数。

$client->bwgroups()->deleteGroup($id);

输入参数

结果

updateGroup - 将已记录在BS/CS中的用户移动到当前用户指定的组中的函数。

$client->bwgroups()->updateGroup($id_user, $id_group);

输入参数

结果

输出用户未读的系统消息的函数。

$client->messages();

可用方法

getList - 输出用户未读的系统消息的函数。消息最大限制为100。

$client->messages()->getList($from);

输入参数

结果

setRead - 将指定未读系统消息标记为已读的函数。

$client->messages()->setRead($ids);

输入参数

结果

setDelete - 删除指定未读系统消息的函数。

$client->messages()->setDelete($ids);

输入参数

结果

readPrivate - 输出与指定用户私信的消息。

$client->messages()->readPrivate($config);

输入参数

结果

getCountUnread - 返回私信未读消息数量，按作者分组。

$client->messages()->getCountUnread();

结果

writePrivate - 向指定用户发送私信的函数。此功能对评分为10000以上的用户开放。消息间的时间间隔为1分钟。

$client->messages()->writePrivate($id_user, $text);

输入参数

结果

输出客户订单拒绝列表的函数。

$client->rating();

可用方法

listTasksFails - 输出客户订单拒绝列表的函数。

$client->rating()->listTasksFails($id_task, $id_user, $back);

输入参数

结果

ratingUserBack - 根据特定拒绝返回执行者评分的函数。

$client->rating()->ratingUserBack($id_task, $id_user);

输入参数

结果

显示两个文本相似程度的函数。

$client->diff();

可用方法

compareText - 显示两个文本相似程度的函数。

$client->diff()->compareText($source, $text);

输入参数

结果

创建文本校对任务的函数。

$client->correction();

可用方法

add - 创建校对任务的函数。

$client->correction()->add($config);

输入参数

结果

import - 从订单和文章创建校对任务的函数。

$client->correction()->import($config);

输入参数

结果