API для работы с TurboText

API позволяет осуществлять работу с TurboText программным способом. Все вопросы, а также пожелания относительно API, направляйте в службу поддержки.

Описание работы с API

URL: http://www.turbotext.ru/api
Формат запроса: POST

Параметры:

  • api_key - идентификационный ключ. Доступен на этой странице для зарегистрированных пользователей;
  • action - выполняемое действие.

Формат ответа: json. Параметры ответа:

  • success (int) - флаг успешно ли завершилась операция;
  • errors (text) - сообщение об ошибке, в случае если операция завершилась неудачно.

Пример PHP-скрипта для работы с API TurboText

Возможные действия и их описание


Работа с заказами на копирайтинг/рерайтинг/переводы

Действие Описание Входные данные Выходные данные
get_folders Возвращает все папки пользователя отсутствуют
  • folders (array) - массив с папками

Каждый элемент массива содержит:

  • id (int) - уникальный идентификатор папки
  • name (text) - имя папки
get_balance Возвращает количество доступных средств отсутствуют
  • balance (float) - количество денег на балансе
  • blocked_money (float) - количество замороженных средств для выполнения заказов и микрозадач
create_folder Создаёт новую папку
  • name (text) - имя новой папки
  • folder_id (int) - уникальный идентификатор созданной папки
get_orders Возвращает все заказы пользователя в папке folder_id. Если folder_id не указано, возвращает все заказы.
  • folder_id (text) - уникальный идентификатор папки (необязательный параметр)
  • orders (array) - массив с заказами

Каждый элемент массива содержит:

  • id (int) - уникальный идентификатор (номер) заказа
  • name (text) - название заказа
  • price (float) - стоимость за 1000 знаков
  • status (int) - статус заказа (1 - в поиске исполнителя, 2 – в работе, 3 – ожидает проверки, 4 – на доработке, 5 – одобрен и оплачен)
create_order Создаёт новый заказ
  • order_title (text) - название заказа
  • order_type (int) - тип заказа (1 - копирайтинг, 2 - рерайтинг)
  • order_description (text) - задание для копирайтера, описание заказа
  • order_text (text) - статья для рерайта, если вы заказываете рерайтинг
  • order_size_from (int) - минимальное количество знаков, которое должно быть в тексте (от 300 до 98000)
  • order_size_to (int) - максимальное количество знаков, которое должно быть в тексте (от 300 до 99000)
  • folder_id (int) - идентификатор папки, в которую нужно добавить заказ
  • order_time (int) - количество часов за которое нужно выполнить заказ (от 2 до 96). Необязательный параметр, значение по умолчанию - 10.
  • order_price (int) - стоимость за 1000 знаков с пробелами (от 22)
  • order_who_can_work (int) - кто может выполнить заказ. 0 - любой исполнитель, 1 - только исполнитель определённого уровня (нужно указать уровень в поле order_who_can_work_value), 2 - только исполнители из белого списка (нужно указать id списка в поле order_who_can_work_value), 3 - только один определённый исполнитель (нужно указать id исполнителя в поле order_who_can_work_value). Параметр необязательный. Значение по умолчанию - 0.
  • order_who_can_work_value (int) - в случае, если вы ограничили заказ, сделав его доступным определённой группе исполнителей параметром order_who_can_work, в этом параметре необходимо уточнить свой выбор:
    • В случае, если вы хотите сделать заказ доступным только исполнителям определённого уровня, то укажите в этом параметре цифру, соответствующую уровню (1 - новичок, 2 - базовый уровень, 3 - высокий уровень, 4 - профи).
    • В случае, если вы хотите сделать заказ доступным только для определённого белого списка, то укажите id списка в этом поле.
    • В случае, если вы хотите сделать персональный заказ только для одного конкретного исполнителя, то укажите в этом поле его id
  • order_need_anons (int) - Нужен ли вам анонс? 1 - да, 0 - нет. Необязательный параметр, значение по умолчанию - 0
  • order_need_corrector (int) - Нужно ли проверить текст корректором? 1 - да, 0 - нет. Необязательный параметр, значение по умолчанию - 0
  • order_need_unique (int) - Нужно ли проверить текст на уникальность? 1 - да, 0 - нет. Необязательный параметр, значение по умолчанию - 0
  • order_need_image (int) - Нужно ли прикрепить к заказу картинку? 1 - да, 0 - нет. Необязательный параметр, значение по умолчанию - 0
  • draft (int) - Сохранить заказ как черновик? 1 - да, 0 - нет. Необязательный параметр, значение по умолчанию - 0
  • order_id (int) - уникальный идентификатор созданного заказа
get_order Получает информацию о заказе order_id
  • order_id (int) - уникальный идентификатор (номер) заказа.
  • name (text) - название заказа
  • price (float) - стоимость за 1000 знаков
  • status (int) - статус заказа (1 - в поиске исполнителя, 2 – в работе, 3 – ожидает проверки, 4 – на доработке, 5 – одобрен и оплачен)
  • worker_id (int) - уникальный идентификатор исполнителя, работающего над заказом. Если равно 0, значит над заказом никто не работает.
  • description (text) - задание для копирайтера, описание заказа
  • date_add (datetime) - дата публикации заказа
  • date_upd (datetime) - дата последнего обновления заказа
  • type (int) - тип заказа (1 - копирайтинг, 2 - рерайтинг)
  • min_ch (int) - минимальное необходимое количество символов
  • max_ch (int) - максимальное необходимое количество символов
  • title (text) - заголовок статьи
  • anons (text) - анонс
  • text (text) - текст статьи
  • tags (text) - теги
  • category (text) - категория, выбранная копирайтером
  • image (text) - картинка, прикреплённая к заказу
  • unique (float) - значение уникальности текста (если была заказана проверка)
delete_order Удаляет заказ order_id
  • order_id (int) - уникальный идентификатор (номер) заказа.
Отсутствуют
reject_order Отправить заказ на доработку
  • order_id (int) - уникальный идентификатор (номер) заказа
  • text (text) - причина, по которой вы отправляете заказ на доработку
Отсутствуют
decline_order Отклонить заказ
  • order_id (int) - уникальный идентификатор (номер) заказа
  • text (text) - причина, по которой вы отказываетесь от заказа
Отсутствуют
accept_order Принять заказ
  • order_id (int) - order_id (int) - уникальный идентификатор (номер) заказа
Отсутствуют
move_order Переместить заказ в определённую папку
  • order_id (int) - уникальный идентификатор (номер) заказа
  • folder_id (int) уникальный идентификатор папки, в которую нужно переместить заказ.
Отсутствуют

Работа со списками исполнителей

Действие Описание Входные данные Выходные данные
get_user Возвращает информацию о пользователе
  • user_id (int) - уникальный идентификатор пользователя
  • user_name (text) - ник пользователя
  • user_rating (int) - рейтинг пользователя в системе
  • user_type (int) - тип пользователя (1 - исполнитель, 2 - заказчик, 3 - корректор)
get_lists Возвращает все белые списки пользователя Отсутствуют
  • lists (array) - массив со списками

Каждый элемент массива содержит:

  • id (int) - уникальный идентификатор списка
  • name (text) - имя списка
get_list Возвращает всех исполнителей, которые присутствуют в определённом белом списке
  • list_id (int) - уникальный идентификатор списка
  • users (array) - массив с исполнителями

Каждый элемент массива содержит:

  • user_id (int) - уникальный идентификатор пользователя
add_to_list Добавляет пользователя в список
  • list_id (int) - уникальный идентификатор списка, в который нужно добавить пользователя
  • user_id (int) - уникальный идентификатор пользователя
Отсутствуют
remove_from_list Удаляет пользователя из списка
  • list_id (int) - уникальный идентификатор списка, из которого нужно удалить пользователя
  • user_id (int) - уникальный идентификатор пользователя
Отсутствуют
add_to_black_list Добавляет пользователя в черный список
  • user_id (int) - уникальный идентификатор пользователя
Отсутствуют
remove_from_black_list Удаляет пользователя из черного списка
  • user_id (int) - уникальный идентификатор пользователя
Отсутствуют

Работа с микрозадачами

Действие Описание Входные данные Выходные данные
get_microtasks_folders Возвращает все папки для микрозадач отсутствуют
  • folders (array) - массив с папками

Каждый элемент массива содержит:

  • id (int) - уникальный идентификатор папки
  • name (text) - имя папки
create_microtasks_folder Создаёт новую папку для микрозадач
  • name (text) - имя новой папки
  • folder_id (int) - уникальный идентификатор созданной папки
get_microtasks_orders Возвращает все микрозадачи в папке folder_id. Если folder_id не указано, возвращает все микрозадачи.
  • folder_id (int) - уникальный идентификатор папки (необязательный параметр)
  • orders (array) - массив с микрозадачами

Каждый элемент массива содержит:

  • id (int) - уникальный идентификатор (номер) задачи
  • name (text) - название задачи
  • price (float) - стоимость за выполнение задачи
  • active (int) - статус задание (1 - активно, 0 – выключено)
create_microtask Создаёт новую микрозадачу
  • microtask_title (text) - название микрозадачи
  • microtask_descr (text) - подробное описание задания
  • microtask_price (int) - стоимость задания в рублях (целое число больше или равное 2)
  • microtask_folder_id (int) - идентификатор папки, в которую нужно добавить микрозадачу
  • microtask_time (int) - количество часов за которое нужно выполнить микрозадачу (от 1 до 240). Необязательный параметр, значение по умолчанию - 12.
  • limit_per_user (int) - лимит для одного исполнителя (сколько заданий может выполнить 1 исполнитель). 0 - без ограничений. Необязательный параметр, значение по умолчанию - 0.
  • limit_per_day (int) - лимит в сутки. 0 - без ограничений. Необязательный параметр, значение по умолчанию - 0.
  • limit_total (int) - лимит на общее количество выполнений задания. 0 - без ограничений. Необязательный параметр, значение по умолчанию - 0.
  • who_can_work (int) - кто может выполнить заказ. 0 - любой исполнитель, 2 - только исполнители из белого списка (нужно указать id списка в поле who_can_work_value), 3 - только один определённый исполнитель (нужно указать id исполнителя в поле order_who_can_work_value). Параметр необязательный. Значение по умолчанию - 0.
  • who_can_work_value (int) - в случае, если вы ограничили заказ, сделав его доступным определённой группе исполнителей параметром who_can_work, в этом параметре необходимо уточнить свой выбор:
    • В случае, если вы хотите сделать заказ доступным только для определённого белого списка, то укажите id списка в этом поле.
    • В случае, если вы хотите сделать персональный заказ только для одного конкретного исполнителя, то укажите в этом поле его id
  • microtask_id (int) - уникальный идентификатор созданной микрозадачи
get_microtasks_tasks Возвращает все отчёты о выполненных заданиях, ожидающие проверки, для микрозадачи microtask_id. Если microtask_id не указано, возвращает все отчёты, ожидающие проверки.
  • microtask_id (int) - уникальный идентификатор микрозадачи (необязательный параметр)
  • tasks (array) - массив с отчётами

Каждый элемент массива содержит:

  • id (int) - уникальный идентификатор (номер) отчёта
  • user_id (int) - уникальный идентификатор исполнителя
  • price (int) - стоимость за выполнение задачи
  • text (text) - текст отчёта
microtasks_reject_task Отправить задание на доработку или отказаться от него
  • task_id (int) - уникальный идентификатор (номер) отчёта по задаче
  • text (text) - причина, по которой вы отправляете задачу на доработку или отклоняете
  • decline (int) - в случае, если параметр decline равен 1, то задание будет отклонено без возможности доработки. Необязательный параметр, значение по умолчанию - 0.
Отсутствуют
microtasks_accept_task Принять и оплатить задачу
  • task_id (int) - уникальный идентификатор (номер) отчёта по задаче
Отсутствуют
microtasks_pause Временно остановть выполнение микрозадачи
  • task_id (int) - уникальный идентификатор (номер) микрозадачи
Отсутствуют
microtasks_play Включить выполнение ранее остановленной микрозадачи
  • task_id (int) - уникальный идентификатор (номер) отчёта по задаче
Отсутствуют

Работа с личными сообщениями

Действие Описание Входные данные Выходные данные
pm_get_sent Получить список пользователей, кому вы отправляли личные сообщения Отсутствуют users_array (array) - массив, содержащий ID пользователей
pm_get_received Получить список пользователей, которые вам отправляли личные сообщения Отсутствуют users_array (array) - массив, содержащий ID пользователей
pm_send Отправить личное сообщение
  • user_id (int) - ID пользователя, которому нужно отправить сообщение
  • message (text) - текст сообщения
Отсутствуют
pm_get_conversation Получить переписку с определённым пользователем
  • user_id (int) - ID пользователя, переписку с которым нужно получить
messages_array (array) - массив, содержащий список сообщений. Каждый элемент массива содержит:
  • from_id (int) - ID пользователя от кого сообщение
  • to_id (int) - ID пользователя кому сообщение
  • date (date) - дата отправки
  • unread (bool) - флаг прочитано сообщение или нет
  • text (text) - текст сообщения
Мотать страницу вверх