API определяет набор функций, к которым разработчики могут совершать запросы и получать ответы. Взаимодействие происходит по протоколу HTTP.
Все вызовы методов API - это GET или POST HTTP-запросы к URL https://www.etxt.ru/api/json/ с некоторым набором параметров, URL запроса ОБЯЗАТЕЛЬНО должен содержать 3 нижеприведенных параметра, то есть method, token и sign должны быть переданы только по GET. Вы выбираете в документации нужный метод, например, users.getList, формируете запрос согласно документации метода, и осуществляете этот запрос. В ответ на запрос вы получаете его результат, который также описан в документации каждой функции.
Данные запроса могут передаваться в виде query-строки (после знака ?) при использовании метода GET, либо в теле POST-запроса. Помните, что в случае GET-запроса, параметры должны быть закодированы с помощью URL encoding.
На данный момент, API не делает различий между GET- и POST-запросами. Тем не менее, помните, что существует ограничение на длину URL запроса - 2048 символов. Поэтому мы рекомендуем вам выполнять запросы на получение информации с помощью метода GET (они обычно легко умещаются в ограничение), а запросы на изменение данных - создание/изменение заказа - с помощью метода POST. Так вы не будете ограничены длиной запроса, кроме того, такое использование больше соответствует спецификации протокола HTTP.
Ответ сервера на запрос возвращается только в формате JSON в символьной кодировке Unicode.
Параметры запроса
В каждом запросе должен присутствовать набор обязательных параметров. Также для каждой функции в ее документации определены дополнительные параметры, нужные только для этой функции. Текстовые значения параметров должны быть преданы в кодировке UTF-8. Одинаковые для всех функций параметры перечислены ниже.
| Имя |
Тип |
Описание |
| method |
string |
название вызываемого метода, например, users.getList; обязательный параметр |
| sign |
string |
подпись запроса; обязательный параметр |
| token |
string |
API-ключ текущего пользователя |
Порядок следования параметров в запросе значения не имеет, порядок параметров важен только при расчете подписи.
API-ключ token уникален для каждого пользователя и его можно узнать в разделе "Мой профиль/Настройка интерфейса".
Подпись sign расчитывается в зависимости по алгоритмы, приведенному ниже. Подписываются только параметры, переданные по GET.
Подпись запроса
Чтобы удостовериться, что запрос отправлен действительно вами, а не злоумышленниками от лица вашего приложения, все запросы к API должны быть подписаны. Результат расчета подписи вы должны передать в параметре sign. Биржа проверит подпись и выполнит запрос только если подпись правильная.
Алгоритм использует отдельный ключ api_pass, который мы настоятельно рекомендуем вам хранить только на ваших серверах и использовать только при запросах с них к серверу Биржи. Данный ключ задается в разделе "Мой профиль/Настройки интерфейса".
sign = md5(params.md5(api_pass.'api-pass'))
Значение params — это конкатенация пар «имя=значение отсортированных в алфавитом порядке по «имя», где «имя» — это название параметра, передаваемого в функцию API, «значение» — значение параметра. Разделитель в конкатенации не используется. Параметр sign при расчете подписи не учитывается, все остальные параметры запроса должны учитываться при расчете.
Безопасность схемы основывается на том, что api_pass знаете только вы и Биржа. Поэтому никогда не раскрывайте его третьим лицам. Если у вас возникли сомнения в безопасности api_pass, измените его в настройках профиля.
Функции API
| Функция |
Описание |
| categories.listCategories |
Функция возвращает список тематический категорий заказов/статей |
| folders.listFolders |
Функция возвращает список папок текущего пользователя |
| folders.addFolder |
Функция создает папку для текущего пользователя |
| folders.moveToFolder |
Функция перемещает объекты в папку |
| users.getList |
Функция возвращает список исполнителей |
| users.getBW |
Функция возвращает список пользователей, находящихся в черном и белом списке текущего пользователя |
| users.getNote |
Функция возвращает примечание к указанному пользователю |
| users.getUser |
Функция возвращает подробную информацию об указанном пользователе |
| users.getReports |
Функция возвращает отзывы указанного пользователя |
| users.getUserBW |
Функция возвращает количество белых и черных списков, в которых находится пользователь |
| users.setUserBW |
Функция добавляет или удаляет пользователя в черный/белый список |
| users.getBalance |
Функция возвращает состояние лицевого счета текущего пользователя |
| tasks.listTasks |
Функция возвращает список заказов текущего пользователя, только для заказчика |
| tasks.viewNotes |
Функция возвращает список заявок и комментариев на указанный заказ (или список заказов) текущего пользователя, только для заказчика |
| tasks.viewNotesAll |
Функция возвращает список всех поданных заявок на все заказы текущего заказчика |
| tasks.setNote |
Функция принятия указанной заявки на заказ, только для заказчика |
| tasks.unsetNote |
Функция отклонения указанной заявки на заказ, только для заказчика |
| tasks.paidTask |
Функция принятия заказа на проверке, только для заказчика |
| tasks.cancelTask |
Функция отправки заказа на проверке на доработку, только для заказчика |
| tasks.getResults |
Функция получения результатов по заказам, только для заказчика |
| tasks.deleteTask |
Функция удаления заказов в статусе ожидания исполнителя или из черновика, только для заказчика |
| tasks.saveTask |
Функция добавления/редактирования заказа, только для заказчика |
| tasks.failTask |
Функция отмены просроченного заказа, только для заказчика |
| tasks.copyTask |
Функция копирования заказа, только для заказчика |
| tasks.setDeadline |
Функция продления срока сдачи заказа (и публикации черновика), только для заказчика |
| tasks.saveComment |
Функция добавления комментария к заказу, только для заказчика либо назначенного исполнителя |
| tasks.sendNoteFail |
Функция создания заявки на снятие исполнителя с заказа |
| tasks_archive.listTasks |
Функция получения списка заказов из архива заказов, только для заказчика |
| tasks_archive.getResults |
Функция получения результатов по архивному заказу, только для заказчика |
| options.getLangs |
Функция получения списка языков, используемых в системе |
| articles.getList |
Функция получения списка готовых статей на продажу |
| articles.buy |
Функция осуществляет покупку указанной статьи текущим пользователем |
| articles.getText |
Функция выводит тексты купленных статей для текущего пользователя |
| articles.download |
Функция создает zip архив с текстами и изображениями указанных купленных статей для текущего пользователя |
| articles_archive.getList |
Возвращает список купленных пользователм статей и перенесенных в архив статей |
| articles_archive.getText |
Функция выводит тексты запрошенных статей из архива текущего пользователя |
| articles_archive.download |
Функция создает zip архив с текстами и изображениями указанных статей из архива для текущего пользователя |
| bwgroups.listGroups |
Функция возвращает список групп для БС/ЧС текущего пользователя |
| bwgroups.saveGroup |
Функция добавляет или изменяет группу для БС/ЧС текущего пользователя |
| bwgroups.deleteGroup |
Функция удаляет группу для БС/ЧС текущего пользователя |
| bwgroups.updateGroup |
Функция перемещает пользователя, уже занесенного в БС/ЧС, в указанную группу текущего пользователя |
| messages.getList |
Функция выводит непрочитанные системные сообщения пользователя |
| messages.setRead |
Функция помечает указанные непрочитанные системные сообщения пользователя как прочитанные |
| messages.setDelete |
Функция удаляет указанные непрочитанные системные сообщения пользователя |
| messages.readPrivate |
Функция выводит сообщения из привата с указанным пользователем |
| messages.writePrivate |
Функция посылает сообщение в приват указанному пользователем |
| rating.listTasksFails |
Функция выводит список отказов от заказов для заказчика |
| rating.ratingUserBack |
Функция возвращает рейтинг исполнителю по определенному отказу |
| diff.compareText |
Функция показывает степень схожести двух текстов |
Возможные возвращаемые ошибки
| Ошибка |
Описание |
| no_params |
Отсутствует или некорректен обязательный параметр функции |
| no_object |
Объектов по запросу не найдено |
| is_private_data |
В значениях текстовых параметров используется контактная информация |
| max_limit |
Превышение установленных лимитов операции |
categories.listCategories
Возвращает список тематический категорий заказов/статей, отсортированный по названию категории.
Результат
| Поле |
Описание |
| id_category |
Идентификатор категории |
| id_parent |
Идентификатор родительской категории |
| name |
Название категории |
| keyword |
Ключевое слово категории |
folders.listFolders
Возвращает отсортированный список папок текущего пользователя.
Параметры
| Параметр |
Тип |
Описание |
| sort |
string |
date - сортировка по дате создания, name - по названию (по умолчанию) |
Результат
| Поле |
Описание |
| id_category |
Идентификатор папки |
| id_parent |
Идентификатор родительской папки |
| name |
Название папки |
| depth |
Глубина вложенности папки |
| last |
Флаг, является ли папка последней по глубине вложенности |
folders.addFolder
Cоздает папку для текущего пользователя.
Параметры
| Параметр |
Тип |
Описание |
| name |
string |
Название создаваемой папки (длинна от 1 до 128 знаков) |
| id_parent |
int |
Идентификатор родительской папки или 0 (по умолчанию) для корневой папки |
Результат
| Поле |
Описание |
| id_folder |
Идентификатор созданной папки |
folders.moveToFolder
Фукнция перемещает объекты в папку.
Параметры
| Параметр |
Тип |
Описание |
| id_folder |
string |
Идентификатор папки |
| type |
string |
Тип перемещемых объектов.
Значения:
- task - заказ
- archive - архивный заказ
- article - статья
- article_archive - архивная статья
- correction - коррекция
- bhv_task - задания
|
| ids |
int (array) |
Массив идентификаторов перемещаемых объектов |
Результат
| Поле |
Описание |
| count |
Количество перемещенных объектов |
users.getList
Возвращает список исполнителей без сортировки.
Параметры
| Параметр |
Тип |
Описание |
| 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 |
Рейтинг пользователя |
users.getBW
Функция возвращает список пользователей, находящихся в черном и белом списке текущего пользователя.
Параметры
| Параметр |
Тип |
Описание |
| type |
string |
Тип списка (whiteList - белый список, blackList - черный), по умолчанию все вместе |
Результат
| Поле |
Описание |
| id_user |
Идентификатор пользователя |
| id_group |
Идентификатор группы списка |
| login |
Логин пользователя |
| fio |
ФИО пользователя |
| online |
Онлайн статус пользователя (1 - онлайн, 0 - оффлайн) |
| type |
Тип списка (whiteList - белый список, blackList - черный) |
users.getNote
Функция возвращает примечание к указанному пользователю.
Параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор пользователя, обязательный параметр |
Результат
| Поле |
Описание |
| id_user |
Идентификатор пользователя |
| text |
Текст примечания |
| date |
Дата последнего изменения примечания, unixtime |
users.getUser
Функция возвращает подробную информацию об указанном пользователе.
Параметры
| Параметр |
Тип |
Описание |
| 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 |
Число работ в портфолио, только для исполнителя |
users.getReports
Функция возвращает отзывы указанного незаблокированного пользователя. Отзывы разделены на два массива - negative (отрицательные отзывы) и positive (положительные) и сгруппированы по авторам.
Параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор пользователя, обязательный параметр |
Результат
| Поле |
Описание |
| id_author |
Идентификатор автора отзыва |
| text |
Текст отзыва |
| date |
Дата отзыва, unixtime |
users.getUserBW
Функция возвращает количество белых и черных списков, в которых находится пользователь.
Параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор пользователя, обязательный параметр |
Результат
| Поле |
Описание |
| id_user |
Идентификатор пользователя, у которого считаем (повторяет входящий параметр) |
| whiteList |
Число пользователей, у которых запрашиваемый пользователь в белом списке |
| blackList |
Число пользователей, у которых запрашиваемый пользователь в черном списке |
users.setUserBW
Функция добавляет или удаляет пользователя в черный/белый список.
Параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор добавляемого/удаляемого пользователя, обязательный параметр |
| id_group |
int |
Идентификатор группы БС/ЧС, если не определен, то "без группы" |
| type |
string |
Тип действия: whiteList - в белый список, blackList - в черный, delete - удалить из списка |
Результат
| Поле |
Описание |
| id |
Идентификатор пользователя, над которым производим действие (повторяет входящий параметр) |
| type |
Название выполненного действия |
users.getBalance
Функция возвращает состояние лицевого счета текущего пользователя.
Результат
| Поле |
Описание |
| id |
Идентификатор текущего пользователя |
| balance |
Доступная сумма в рублях на лицевом счета |
| date |
Текущая дата запроса |
tasks.listTasks
Возвращает список заказов текущего пользователя, только для заказчика.
Параметры
| Параметр |
Тип |
Описание |
| 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 - просроченные заказы в работе, по которым не принято решение
|
| 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_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 |
Требование уникальности результата для автоматической отправки на доработку, если поле отсутствует, то параметр в заказе не указан |
| id_target |
Идентификатор пользователя в случае индивидуального заказа, если поле отсутствует, то заказ не индивидуальный |
| keywords |
Список ключевых слов при типе задания "СЕО-копирайтинг" |
language_from
language_to |
Идентификаторы языков переводов при типе задания "Перевод" |
tasks.viewNotes
Функция возвращает список заявок и комментариев на указанный заказ (или список заказов) текущего пользователя, только для заказчика.
Параметры
| Параметр |
Тип |
Описание |
| id |
int (array) |
Идентификатор заказа (-ов, но не более 100), обязательный параметр |
Результат
| Поле |
Описание |
| id |
Идентификатор комментария |
| text |
Текст заявки |
| date |
Дата заявки, unixtime |
| id_user |
Идентификатор автора комментария/заявки |
| login |
Логин автора комментария/заявки |
| id_note |
Идентификатор заявки, если заявка отсутствует, то есть запись - просто комментарий, то значение поля 0 |
| id_task |
Идентификатор заказа |
tasks.viewNotesAll
Функция возвращает список всех поданных заявок на все заказы текущего заказчика.
Результат
| Поле |
Описание |
| id_note |
Идентификатор заявки |
| title |
Название заказа |
| price |
Цена заказа |
| deadline |
Срок сдачи заказа, unixtime |
| id_task |
Идентификатор заказа |
| id_user |
Идентификатор исполнителя |
| user |
Логин исполнителя |
| date |
Дата заявки, unixtime |
| text |
Текст заявки |
tasks.setNote
Функция принятия указанной заявки на заказ, только для заказчика.
Параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор заявки (не комментария!), обязательный параметр |
Результат
| Поле |
Описание |
| id_task |
Идентификатор заказа, если заявка принадлежит мультизаказу, то индентификатор нового созданного заказа, иначе того, на который заявка принята |
| id_user |
Идентификатор пользователя, назначенного исполнителем по принятой заявке |
tasks.unsetNote
Функция отклонения указанной заявки на заказ, только для заказчика.
Параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор заявки (не комментария!), обязательный параметр |
Результат
| Поле |
Описание |
| id_task |
Идентификатор заказа, которому принадлежит отклоненная заявка |
| id_user |
Идентификатор пользователя, заявку которого отклонили |
tasks.paidTask
Функция принятия заказа на проверке, только для заказчика.
Параметры
| Параметр |
Тип |
Описание |
| id |
array (int var1, int var2, ... ) |
Массив идентификаторов принимаемых заказов вида id[]=1&id[]=2, обязательный параметр |
Результат
| Поле |
Описание |
| status |
Флаг успешности принятия |
| ids |
Массив идентификаторов принятых заказов |
tasks.cancelTask
Функция отправки заказа на проверке на доработку, только для заказчика.
Параметры
| Параметр |
Тип |
Описание |
| id |
array (int var1, int var2, ... ) |
Массив идентификаторов отклоняемых заказов вида id[]=1&id[]=2, обязательный параметр |
| text |
string |
Комментарий к отклонению, обязателен, если отклоняется 1 заказа, а не пакет заказов, иначе обнуляется |
Результат
| Поле |
Описание |
| status |
Флаг успешности принятия |
| ids |
Массив идентификаторов отклоненных заказов |
tasks.getResults
Функция получения результатов по заказам, только для заказчика.
Параметры
| Параметр |
Тип |
Описание |
| 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 |
Путь для скачки результата, действительно примерно сутки с момента осуществления запроса |
tasks.deleteTask
Функция удаления заказов в статусе ожидания исполнителя или из черновика, только для заказчика.
Параметры
| Параметр |
Тип |
Описание |
| id |
array (int var1, int var2, ...) |
Массив идентификаторов заказов, обязательный параметр |
Результат
| Поле |
Описание |
| id |
Идентификатор удаленного заказа |
tasks.saveTask
Функция добавления/редактирования заказа, только для заказчика.
Параметры
| Параметр |
Тип |
Описание |
| 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 (копирайтинг) |
| 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 = ИД группы БС) |
Результат
| Поле |
Описание |
| id_tasks |
Идентификатор созданного или отредактированного заказа |
tasks.failTask
Функция отмены просроченного заказа, только для заказчика. Отмененный заказ невозможно удалить, он будет существовать для истории 2 неделе, после чего удалится автоматически.
Параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор просроченного заказа, обязательный параметр |
| copy |
int |
Флаг создания копии отменяемого заказа, если указано и значение 1, то создастся публикуемая копия заказа со сроком, задаваемым параметрами ниже |
| deadline |
string |
Новый срок сдачи в формате дд.мм.гггг, по умолчанию - текущее время плюс 5 суток для несрочного заказа или 5 часов для срочного |
| timeline |
string |
Новое время сдачи в формате чч:мм, 23:59 по умолчанию |
Результат
| Поле |
Описание |
| id |
Идентификатор отмененного заказа |
| id_copy |
Идентификатор созданной копии заказа, если указано копирование |
| rateup |
Ссылка для восстановления рейтинга исполнителю |
tasks.copyTask
Функция копирования заказа, только для заказчика. Новый заказ будет публикуемым и доступный исполнителям, настройки автопринятия и мультизаказа не копируются.
Параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор копируемого заказа, обязательный параметр |
| deadline |
string |
Новый срок сдачи в формате дд.мм.гггг, не более 90 дней, по умолчанию или если некорректное - текущее время плюс 5 суток для несрочного заказа или 5 часов для срочного |
| timeline |
string |
Новое время сдачи в формате чч:мм, 23:59 по умолчанию |
Результат
| Поле |
Описание |
| id_copy |
Идентификатор созданной копии заказа |
tasks.setDeadline
Функция увеличения срока сдачи заказа, только для заказчика. Если заказ просроченный, то он будет возвращен в работу, если в черновике, то возможна его публикации для ожидания подачи заявок.
Параметры
| Параметр |
Тип |
Описание |
| 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 - нет |
tasks.saveComment
Функция добавления комментария в заказ, только для заказчика или назначенного исполнителя.
Параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор заказа, обязательный параметр |
| text |
string |
Текст комментария, максимум 2048 символов, обязательный параметр. |
| hide |
int |
Флаг скрытия текста комментария (1 - скрывать, 0 или отсутствует - не скрывать), необязательный параметр |
Результат
| Поле |
Описание |
| id |
Идентификатор заказа |
| id_comment |
Идентификатор добавленного комментария |
| comments |
Число комментариев в заказе |
tasks.sendNoteFail
Функция создает заявку в обратную связь на снятие исполнителя с заказа.
Параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор заказа, с которого снимать исполнителя, заказ должен быть в статусе "На проверке" и текущий исполнитель должен иметь хоть один сданный результат. |
| text |
string |
Текст заявки на снятие, причины, недочеты. |
Результат
| Поле |
Описание |
| status |
Флаг успешного создания заявки |
| ticket |
Ссылка на созданный тикет в обратную связь |
tasks_archive.listTasks
Возвращает список архивных заказов текущего пользователя, только для заказчика.
Параметры
| Параметр |
Тип |
Описание |
| count |
int |
Число пользователей для выборке, не более 100 за запрос (по умолчанию) |
| from |
int |
Смещение от последней записи в выборке, по умолчанию 0 |
| order |
string |
Порядок сортировки, возможные значения: desc, asc (по умолчанию) |
| id |
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_from
language_to |
Языки переводов при типе задания "Перевод" |
tasks_archive.getResults
Функция получения результатов по архивному заказу, только для заказчика.
Параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор заказа, обязательный параметр |
Результат
| Поле |
Описание |
| id_task |
Идентификатор заказа |
| id_user |
Идентификатор пользователя, сдавшего результат |
| comment |
Комментарий пользователя к сдаче результата |
| content |
Текст результата |
| date |
Дата сдачи результата, unixtime |
| date_reset |
Дата отправки результата на доработку, unixtime |
| check |
Массив параметров проверки результата системой |
| files |
Массив файлов результата, ссылки на файлы действительны примерно сутки |
options.getLangs
Функция получения списка языков, используемых в системе.
Результат
Возвращается массив, где ключ - идентификатор языка, значение - название языка.
articles.getList
Возвращает список готовых статей на продажу. Поле "Описание статьи" не выводится во избежание автоматической выемки всех описаний статей.
Параметры
| Параметр |
Тип |
Описание |
| count |
int |
Число статей для выборке, не более 20 за запрос (по умолчанию) |
| from |
int |
Смещение от последней записи в выборке, по умолчанию 0 |
| id_user |
int |
Идентификатор автора статьи для фильтрации списка |
| id_category |
int |
Идентификатор категории статьи для фильтрации списка |
| id_subtype |
int |
Идентификатор типа статьи для фильтрации списка (от 1 до 10) |
| filter |
int |
Флаг показа купленных статей текущим пользователем, если указано 1, то будут выбраны только купленные статьи текущим пользователем, иначе только статьи на продажу |
| id |
int |
Идентификатор статьи: будет выбрана только указанная статья |
| text |
string (40) |
Строка для поиска по названию, описанию и ключевым словам |
| price_from, price_to, price_type |
int |
Фильтрация по цене, от ... до, если указан параметр price_type (любое значение), то поиск по цене за 1000 знаков |
| size_from, size_to |
int |
Фильтрация по размеру текста, от ... до |
| uniq_from, uniq_to |
int |
Фильтрация по уникальности статьи, от ... до |
| id_language |
int |
Фильтрация по языку статьи, список идентификаторов options.getLangs, если 0 или ошибочен, то без учета параметра |
| sort |
string |
Сортировка статей, значения: relevancy (по релевантности при поиске по тексту), title (по названию), price (по цене), size (по размеру), uniq (по уникальности), date (по дате добавления - по умолчанию) |
| order |
string |
Порядок сортировки статей, только при заданном параметре sort, значения: desc (по убыванию), asc (по возрастанию) |
Результат
| Поле |
Описание |
| id |
Идентификатор статьи |
| title |
Название статьи |
| keywords |
Ключевые слова статьи |
| date |
Дата добавления статьи, unixtime |
| id_type |
Идентификатор типа текста статьи |
| id_subtype |
Идентификатор типа статьи (1 - общая статья, 2 - новость, 3 - описание товара для интернет-магазина, 4 - обзор товара, 5 - кулинарный рецепт, 6 - мастер-классы (рукоделие, поделки и проч.), 7 - пресс-релиз, 8 - эссе, 9 - статья для главной страницы сайта, 10 - лирика (стихотворение)) |
| id_folder |
Идентификатор папки купленной статьи |
| id_category |
Идентификатор категории статьи |
| id_language |
Идентификатор языка текста статьи |
| full_price |
Цена статьи, включая комиссию для покупателя |
| size |
Число символов в статье |
| images |
Число изображений в статье |
| unq, unq_shin |
Уникальность статьи в % (проверка на рерайтинг и проверка на копии) |
| moder_check |
Флаг проверки статьи (авто)модератором на качество |
| moder_orph |
Оценка орфографии (1 - без ощибок, 0 - с ошибками) |
| moder_punc |
Оценка пунктуации и грамматики (1 - без ощибок, 0 - с ошибками) |
| moder_style |
Оценка стилистики (1 - без ощибок, 0 - с ошибками) |
articles.buy
Функция осуществляет покупку указанной статьи текущим пользователем
Параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор покупаемой статьи |
Результат
| Поле |
Описание |
| id |
Идентификатор купленной статьи |
articles.getText
Функция выводит тексты запрошенных купленных статей
Параметры
| Параметр |
Тип |
Описание |
| id |
array (int var1, int var2, ...) |
Массив идентификаторов купленных статей |
Результат
| Поле |
Описание |
| id |
Идентификатор купленной статьи |
| title |
Название купленной статьи |
| description |
Описание статьи |
| text |
Текст купленной статьи |
articles.download
Функция создает zip архив с текстами и изображениями указанных купленных статей для текущего пользователя
Параметры
| Параметр |
Тип |
Описание |
| id |
array (int var1, int var2, ...) |
Массив идентификаторов купленных статей |
Результат
| Поле |
Описание |
| path |
Путь для скачки ZIP архива |
articles_archive.getList
Возвращает список купленных пользователм статей и перенесенных в архив статей.
Параметры
| Параметр |
Тип |
Описание |
| count |
int |
Число статей для выборке, не более 20 за запрос (по умолчанию) |
| from |
int |
Смещение от последней записи в выборке, по умолчанию 0 |
| id_user |
int |
Идентификатор автора статьи для фильтрации списка |
| id_subtype |
int |
Идентификатор типа статьи для фильтрации списка (от 1 до 10) |
| order |
string |
Порядок сортировки, возможные значения: desc, asc (по умолчанию) |
| id_category |
int |
Идентификатор категории статьи для фильтрации списка |
| text |
string (40) |
Строка для поиска по названию, описанию и ключевым словам |
Результат
| Поле |
Описание |
| id |
Идентификатор статьи |
| title |
Название статьи |
| description |
Описание статьи |
| keywords |
Ключевые слова статьи |
| date |
Дата добавления статьи, unixtime |
| id_type |
Идентификатор типа текста статьи |
| id_subtype |
Идентификатор типа статьи |
| id_category |
Идентификатор категории статьи |
| id_language |
Идентификатор языка текста статьи |
| full_price |
Цена статьи, включая комиссию для покупателя |
| size |
Число символов в статье |
| images |
Число изображений в статье |
| quality |
Массив качественных оценок статьи, если она была проверена (авто)модератором |
articles_archive.getText
Функция выводит тексты запрошенных статей из архива текущего пользователя
Параметры
| Параметр |
Тип |
Описание |
| id |
array (int var1, int var2, ...) |
Массив идентификаторов статей в архиве |
Результат
| Поле |
Описание |
| id |
Идентификатор статьи |
| title |
Название статьи |
| description |
Описание статьи |
| text |
Текст статьи |
articles_archive.download
Функция создает zip архив с текстами и изображениями указанных статей из архива для текущего пользователя
Параметры
| Параметр |
Тип |
Описание |
| id |
array (int var1, int var2, ...) |
Массив идентификаторов статей из архива |
Результат
| Поле |
Описание |
| path |
Путь для скачки ZIP архива |
bwgroups.listGroups
Функция возвращает список групп для БС/ЧС текущего пользователя.
Результат
| Поле |
Описание |
| id_category |
Идентификатор группы |
| id_parent |
Идентификатор родительской группы |
| name |
Название группы |
| depth |
Глубина вложенности группы |
| last |
Флаг, является ли группа последней по глубине вложенности |
bwgroups.saveGroup
Функция добавляет или изменяет группу для БС/ЧС текущего пользователя.
Параметры
| Параметр |
Тип |
Описание |
| name |
string |
Название группы, до 40 символов |
| id |
int |
Идентификатор редактируемой группы, если не указан, будет создана новая |
| id_parent |
int |
Идентификатор родительской категории, по умолчанию 0 - корень |
Результат
| Поле |
Описание |
| id |
Идентификатор созданной или отредактированной группы |
bwgroups.deleteGroup
Функция удаляет группу для БС/ЧС и все ее подгруппы текущего пользователя.
Параметры
| Параметр |
Тип |
Описание |
| id |
int |
Идентификатор удаляемой группы |
Результат
| Поле |
Описание |
| ids |
Массив идентификаторов удаленных групп |
bwgroups.updateGroup
Функция перемещает пользователя, уже занесенного в БС/ЧС, в указанную группу текущего пользователя.
Параметры
| Параметр |
Тип |
Описание |
| id_user |
int |
Идентификатор пользователя, уже внесенного в БС/ЧС, для переноса в другую группу |
| id_group |
int |
Идентификатор группы для переноса, если 0 или не указана, то считается как "без группы" |
Результат
| Поле |
Описание |
| id_user |
Идентификатор перенесенного пользователя |
| id_group |
Идентификатор группы, куда перенесен пользователь |
| name |
Название группы, куда перенесе пользователь, если пустая строка, значит пользователь удален из всех групп |
messages.getList
Функция выводит непрочитанные системные сообщения пользователя. Максимальный лимит сообщений 100.
Параметры
| Параметр |
Тип |
Описание |
| from |
int |
Дата, с которой выводить сообщения, unixtime |
Результат
| Поле |
Описание |
| id |
Идентификатор сообщения |
| date |
Дата сообщения, unixtime |
| text |
Текст сообщения, может содержаить HTML или BB форматирование |
messages.setRead
Функция помечает указанные непрочитанные системные сообщения пользователя как прочитанные.
Параметры
| Параметр |
Тип |
Описание |
| ids |
array (int var1, int var2, ...) |
Массив идентификаторов сообщений |
Результат
| Поле |
Описание |
| ids |
Массив идентификаторов отмеченных сообщений |
messages.setDelete
Функция удаляет указанные непрочитанные системные сообщения пользователя.
Параметры
| Параметр |
Тип |
Описание |
| ids |
array (int var1, int var2, ...) |
Массив идентификаторов сообщений |
Результат
| Поле |
Описание |
| ids |
Массив идентификаторов удаленных сообщений |
messages.readPrivate
Функция выводит сообщения из привата с указанным пользователем.
Параметры
| Параметр |
Тип |
Описание |
| 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 - не прочитано |
messages.writePrivate
Функция посылает сообщение в приват указанному пользователем. Данная возможность доступна пользователям с рейтингом более 10000. Таймаут между сообщениями 1 минута.
Параметры
| Параметр |
Тип |
Описание |
| id_user |
int |
Идентификатор пользователя, обязательный параметр |
| text |
string |
Текст сообщения, максимально 10000 символов |
Результат
| Поле |
Описание |
| id_user |
Идентификатор пользователя, которому посылается сообщение |
| text |
Текст сообщения |
| time |
Время отсылки, unixtime |
rating.listTasksFails
Функция выводит список отказов от заказов для заказчика.
Параметры
| Параметр |
Тип |
Описание |
| id_task |
int |
Идентификатор конкретного заказа |
| id_user |
int |
Идентификатор конкретного исполнителя |
| back |
int |
Флаг фильтрации по статусу возврата (1 - с возвратом рейтинга, 2 - без возврата, 0 - все, по умолчанию) |
Результат
| Поле |
Описание |
| id_task |
Идентификатор заказа |
| id_user |
Идентификатор исполнителя |
| date |
Дата отказа, unixtime |
| date_back |
Дата возврата рейтинга, unixtime |
| back |
Флаг возврата рейтинга |
| title |
Название заказа |
rating.ratingUserBack
Функция возвращает рейтинг исполнителю по определенному отказу.
Параметры
| Параметр |
Тип |
Описание |
| id_task |
int |
Идентификатор конкретного заказа |
| id_user |
int |
Идентификатор конкретного исполнителя |
Результат
| Поле |
Описание |
| id_task |
Идентификатор заказа |
| id_user |
Идентификатор исполнителя |
| rate_back |
Количество возвращенного рейтинга исполнителю |
diff.compareText
Функция показывает степень схожести двух текстов
Параметры
| Параметр |
Тип |
Описание |
| source |
string |
Исходный текст (длина от 30 до 20000 знаков) |
| text |
string |
Текст для сравнения (длина от 30 до 20000 знаков) |
Результат
| Поле |
Описание |
| result |
Процент совпадений |
| text |
Результат сравнения для text |
| source |
Результат сравнения для source |
