Авторизация

Взаимодействие партнера с системой происходит посредством POST запросов и JSON ответов. Все общение происходит в кодировке UTF-8, ответ полученный в другой кодировке может привести к ошибкам в работе.

Все запросы отправляются на https://miratext.ru/api2/call.

Все запросы должны содержать параметр api_key (получается в интерфейсе системы).

Заказы

Создать заказ

https://miratext.ru/api2/call/order/create

Параметры запроса:

Параметр Тип Описание
status string Статус создаваемого заказа,

допустимые значения:
'draft' - 'черновик',
'tender' - 'тендер',
По умолчанию 'tender'.
type_tender string Тип тендера,

допустимые значения:
'first' - 'тендер',
'selection' - 'заявка',
По умолчанию 'first'.
type_work string Тип заказа (обязательный параметр),

допустимые значения:
'copyright' - 'Копирайтинг',
'rewrite' - 'Рерайтинг',
'special' - 'Спецзаказ'
self_price float Цена за 1000 символов (обязательный параметр)
worker_level string Уровень копирайтера,

допустимые значения:
'novice' - 'Опытный',
'intermediate' - 'Профи',
'advanced' - 'Мастер'
По умолчанию 'novice'.
description string Техническое задание (обязательный параметр).
note string Заметка.
min_symbols int Фиксированное количество символов (обязательный параметр). От 200 до 10000.
range_min_symbols int Плавающее количество символов. Указываете минимальный объем, а в параметре min_symbols передаете максимальное количество символов. От 200 до 10000.
working_period int Время исполнения,

допустимые значения:
1 - '1 час',
3 - '3 часа',
6 - '6 часов'
12 - '12 часов',
24 - '24 часа',
36 - '36 часов'
48 - '2 дня',
72 - '3 дня',
96 - '4 дня'
120 - '5 дней',
144 - '6 дней',
168 - 'неделя'
По умолчанию 48.
project_id int id проекта в системе (создается методом https://miratext.ru/api2/call/project/create)
is_need_corrector boolean Проверка корректором, по умолчанию false.
get_image boolean Тематическое изображение, по умолчанию false.
miralinks_warranty boolean Гарантия модерации, по умолчанию false.
* если включен параметр miralinks_warranty, то проверка редактром тоже будет включена
title string Название заказа
stop_words string Cтоп-слова (слова или словосочетания через запятую)
special_thematic_id int id спецтематики в системе, используется когда выбран type_work = 'special'

допустимые значения:
Статьи
    102 - копирайтинг
    103 - рерайтинг
    104 - исследования, аналитика
    105 - продающие тексты
    106 - пресс-релизы
    107 - соцсети
Иностранный язык
    58 - английский
    62 - китайский
    111 - испанский
Необычные
    109 - набор текста
    110 - стихи, рассказы, сказки
publication_system boolean Активация услуги "Публикация готового заказа на сайте". Активируется только в том случае, если заказ создается в проекте, где уже подключен сайт для размещения.
referrer_id int ID своего аккаунта.
check_unique_type string Алгоритм требуемой уникальности

допустимые значения:
'contentwatch' - 'https://content-watch.ru/text/'
'textru' - 'http://text.ru/'
'prcyru' - 'http://pr-cy.ru/unique/'
'advegoru' - 'http://advego.ru/plagiatus/'
'etxtru' - 'https://www.etxt.ru/antiplagiat/'
'antiplagiatru' - 'http://www.antiplagiat.ru/'
'plagiarismaru' - 'http://plagiarisma.ru/'
'empty' - 'Проверка не нужна'
min_unique_percent int Требуемая уникальность.
keyword_urls array Массив ключей вида:
Параметр Тип Описание
keyword string ключ
change_keyword boolean изменять
url string url
is_need_meta_title bool Добавлять мета-тег Title (по умолчанию включено)
meta_title_symbols_min int минимальное количество символов мета-тега Title (по умолчанию 25)
meta_title_symbols_max int максимальное количество символов мета-тега Title (по умолчанию 250)
check_unique_meta_title bool Проверять мета-тег Title на уникальность (по умолчанию выключено)
is_need_meta_description bool Добавлять мета-тег Description (по умолчанию включено)
meta_description_symbols_min int минимальное количество символов мета-тега Description (по умолчанию 50)
meta_description_symbols_max int максимальное количество символов мета-тега Description (по умолчанию 250)
check_unique_meta_description bool Проверять мета-тег Description на уникальность (по умолчанию выключено)
external_id int id заказа во внешней системе
files array массив файлов [file1, file2, file3, ...]
Поля в массиве file
Параметр Тип Описание
name string имя файла
data string файл закодированный в base64
is_description_html int Формат технического задания.

допустимые значения:
1 - 'html',
0 - 'чистый текст'.
По умолчанию: 0.
is_worker_offer_price int Заказ без цены.

допустимые значения: 0, 1. По умолчанию: 0.

Если вы не можете заранее оценить стоимость заказа, воспользуйтесь этой опцией. Авторы будут присылать заявки со своей стоимостью выполнения этой работы. Останется только выбрать понравившийся вариант.

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok",
"order_id":"111111"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
order_id int id заказа в системе

Ошибочный ответ

{
  "result":"error",
  "message": Минимальная стоимость для выбранного уровня копирайтера 75 руб.
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Редактировать заказ

https://miratext.ru/api2/call/order/edit

Параметры запроса:

Параметр Тип Описание
order_id int id редактируемого заказа.
type_work string Тип заказа,

допустимые значения:
'copyright' - 'Копирайтинг',
'rewrite' - 'Рерайтинг',
'special' - 'Спецзаказ'
self_price float Цена за 1000 символов
worker_level string Уровень копирайтера,

допустимые значения:
'novice' - 'Опытный',
'intermediate' - 'Профи',
'advanced' - 'Мастер'
По умолчанию 'novice'.
description string Техническое задание.
note string Заметка.
min_symbols int Фиксированное количество символов. От 200 до 10000.
range_min_symbols int Плавающее количество символов. Указываете минимальный объем, а в параметре min_symbols передаете максимальное количество символов. От 200 до 10000.
working_period int Время исполнения,

допустимые значения:
1 - '1 час',
3 - '3 часа',
6 - '6 часов'
12 - '12 часов',
24 - '24 часа',
36 - '36 часов'
48 - '2 дня',
72 - '3 дня',
96 - '4 дня'
120 - '5 дней',
144 - '6 дней',
168 - 'неделя'
По умолчанию 48.
project_id int id проекта в системе (создается методом https://miratext.ru/api2/call/project/create)
is_need_corrector boolean Проверка корректором, по умолчанию false.
get_image boolean Тематическое изображение, по умолчанию false.
miralinks_warranty boolean Гарантия модерации, по умолчанию false.
* если включен параметр miralinks_warranty, то проверка редактром тоже будет включена
title string Название заказа
stop_words string Cтоп-слова (слова или словосочетания через запятую)
special_thematic_id int id спецтематики в системе, используется когда выбран type_work = 'special'

допустимые значения:
Статьи
    102 - копирайтинг
    103 - рерайтинг
    104 - исследования, аналитика
    105 - продающие тексты
    106 - пресс-релизы
    107 - соцсети
Иностранный язык
    58 - английский
    62 - китайский
    111 - испанский
Необычные
    109 - набор текста
    110 - стихи, рассказы, сказки
publication_system boolean Активация услуги "Публикация готового заказа на сайте". Активируется только в том случае, если заказ создается в проекте, где уже подключен сайт для размещения.
is_need_meta_title bool Добавлять мета-тег Title (по умолчанию включено)
meta_title_symbols_min int минимальное количество символов мета-тега Title (по умолчанию 25)
meta_title_symbols_max int максимальное количество символов мета-тега Title (по умолчанию 250)
check_unique_meta_title bool Проверять мета-тег Title на уникальность (по умолчанию выключено)
is_need_meta_description bool Добавлять мета-тег Description (по умолчанию включено)
meta_description_symbols_min int минимальное количество символов мета-тега Description (по умолчанию 50)
meta_description_symbols_max int максимальное количество символов мета-тега Description (по умолчанию 250)
check_unique_meta_description bool Проверять мета-тег Description на уникальность (по умолчанию выключено)
is_description_html int Формат технического задания.

допустимые значения:
1 - 'html',
0 - 'чистый текст'.
По умолчанию: 0.

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok",
"order_id":"111111"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
order_id int id заказа в системе

Ошибочный ответ

{
  "result":"error",
  "message": Минимальная стоимость для выбранного уровня копирайтера 75 руб.
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Список заказов

https://miratext.ru/api2/call/order/list

Параметры запроса:

Параметр Тип Описание
order_id array массив id заказов в системе
project_id int id проекта.
project_id=null - заказы "без проекта"
status string статусы заказа через запятую

допустимые значения:
'draft' - 'черновик',
'tender' - 'на тендере',
'offered' - 'предложен',
'working' - 'в работе',
'checking' - 'на проверке',
'correcting' - 'у корректора',
'waiting' - 'на приемке',
'reworking' - 'на доработке',
'approved' - 'одобрен',
'accepted' - 'завершен',
'arbitrage' - 'в арбитраже',

Метод возвращает следующие параметры:

Успешный ответ

		{
		  "result":"ok",
		  "orders":[{order1},{order2},...]
		}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
orders array массив заказов

Каждый заказ может содержать массивы Order, Article, Message, OrderKeyword. Если заказ с типом тендера "заявка" и в статусе "тендер", то он может содержать массив Bid

Поля в массиве Order
Параметр Тип Описание
id int id заказа в системе
status string статус заказа

допустимые значения:
'draft' - 'черновик',
'tender' - 'на тендере',
'offered' - 'предложен',
'working' - 'в работе',
'checking' - 'на проверке',
'correcting' - 'у корректора',
'waiting' - 'на приемке',
'reworking' - 'на доработке',
'approved' - 'одобрен',
'accepted' - 'завершен',
'arbitrage' - 'в арбитраже',
type_tender string Тип тендера,

допустимые значения:
'first' - 'тендер',
'selection' - 'заявка',
По умолчанию 'first'.
worker_id int id копирайтера в системе
type_work string Тип заказа
worker_level string Уровень копирайтера
description string Техническое задание
note string Заметка
self_price float Цена за 1000 символов
full_price string Стоимость за весь заказ
working_period int Время исполнения
decline_message string Сообщение о доработке
arbitrage_message string Текст обращения в арбитраж
date_created date Дата создания заказа
date_tender_started date Дата отправки заказа на тендер
date_tender_closing date Дата завершения тендера (если заказ не будет взят в течение 48 часов, то он вернется в черновики)
date_tender_ended date Фактическая дата завершения тендера
date_working_started date Дата взятия заказа в работу
date_working_closing date Дата, когда копирайтер должен написать статью
date_working_ended date фактическая дата написания статьи
date_approved date Дата одобрения заказа
date_updated date Дата изменения заказа
is_need_corrector int Проверка корректором
miralinks_warranty int Гарантия модерации
get_image int Тематическое изображение
title string Название заказа
stop_words string Cтоп-слова
date_accepted date Дата оплаты заказа
date_auto_accepted date Дата, когда заказ должен будет оплатиться автоматически
is_archived int Архивный или нет.
special_thematic_id int id спецтематики в системе, используется когда выбран type_work = 'special'
min_symbols int Минимальное количество символов. От 500 до 10000. Если разница между максимальным и минимальным объемом 300 символов, то заказ с фиксированным объемом. Оплата строго за минимальное количество символов.
max_symbols int Максимальное количество символов. До 10300. Если разница между максимальным и минимальным объемом более 500 символов, то оплата заказа высчитывается исходя за фактического объема, но замораживаются средства за максимальное количество символов.
check_unique_type string Алгоритм требуемой уникальности
допустимые значения:
'contentwatch' - 'https://content-watch.ru/text/'
'textru' - 'http://text.ru/'
'prcyru' - 'http://pr-cy.ru/unique/'
'advegoru' - 'http://advego.ru/plagiatus/'
'etxtru' - 'https://www.etxt.ru/antiplagiat/'
'antiplagiatru' - 'http://www.antiplagiat.ru/'
'plagiarismaru' - 'http://plagiarisma.ru/'
'empty' - 'Проверка не нужна'
min_unique_percent int Требуемая уникальность.
is_need_meta_title bool Добавлять мета-тег Title
meta_title_symbols_min int минимальное количество символов мета-тега Title
meta_title_symbols_max int максимальное количество символов мета-тега Title
check_unique_meta_title bool Проверять мета-тег Title на уникальность
is_need_meta_description bool Добавлять мета-тег Description
meta_description_symbols_min int минимальное количество символов мета-тега Description
meta_description_symbols_max int максимальное количество символов мета-тега Description
check_unique_meta_description bool Проверять мета-тег Description на уникальность
external_id int id заказа во внешней системе
Поля в массиве Article
Параметр Тип Описание
id int id статьи в системе
title string Название
meta_title string title
meta_keywords string keywords
meta_description string description
snippet string Текст анонса
content string Статья в html формате
unique_percent float Уникальность
nausea float Тошнота
symbols int Количество символов
wateriness float Водянистость
Поля в массиве Message
Параметр Тип Описание
id int id сообщения в системе
from_user_id int id пользователя от которого пришло сообщение
to_user_id int id пользователя кому пришло сообщение
message int Текст сообщения
date_created int Дата сообщения
Поля в массиве Bid
Параметр Тип Описание
id int id заявки
worker_id int id копирайтера
price float Стоимость копирайтера (может предложить как меньшую, так и большую)
description string Текст заявки от копирайтера
date_created date Дата подачи заявки
Worker array массив с информацией о копирайтере
Поля в массиве Worker
Параметр Тип Описание
id int id копирайтера
title string имя копирайтера
rating string Рейтинг копирайтера
Поля в массиве OrderKeyword
Параметр Тип Описание
keyword string ключ
change_keyword boolean изменять
url string url

Отправить заказ на доработку

https://miratext.ru/api2/call/order/sendToRework

Параметры запроса:

Параметр Тип Описание
order_id int id заказа в системе
message string текст доработки

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok",
"order_id":"111111"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
order_id int id заказа в системе

Ошибочный ответ

{
  "result":"error",
  "message": Неверный статус заказа
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Отправить заказ на тендер

https://miratext.ru/api2/call/order/sendToTender

Параметры запроса:

Параметр Тип Описание
order_id int id заказа в системе

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok",
"order_id":"111111"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
order_id int id заказа в системе

Ошибочный ответ

{
  "result":"error",
  "message": Неверный статус заказа
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Отправка заказа по заявке

https://miratext.ru/api2/call/order/sendBidToWorker

Параметры запроса:

Параметр Тип Описание
order_id int id заказа в системе
worker_id int id копирайтера в системе

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok",
"order_id":"111111"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
order_id int id заказа в системе

Ошибочный ответ

{
  "result":"error",
  "message": Неверный статус заказа
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Отправка заказа копирайтеру

https://miratext.ru/api2/call/order/sendToWorker

Параметры запроса:

Параметр Тип Описание
order_id int id заказа в системе
worker_id int id копирайтера в системе

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok",
"order_id":"111111"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
order_id int id заказа в системе

Ошибочный ответ

{
  "result":"error",
  "message": Неверный статус заказа
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Снять заказ с тендера

https://miratext.ru/api2/call/order/cancelTender

Параметры запроса:

Параметр Тип Описание
order_id int id заказа в системе

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok",
"order_id":"111111"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
order_id int id заказа в системе

Ошибочный ответ

{
  "result":"error",
  "message": Неверный статус заказа
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Отозвать заказ

Отозвать заказ можно в нескольких случаях: заказ предложен копирайтеру; первые 30 минут с момента, когда заказ взят в работу; в момент, когда заказ просрочен (в статусах: "в работе" и "на доработке"). Заказ отзывается в черновик.

https://miratext.ru/api2/call/order/callback

Параметры запроса:

Параметр Тип Описание
order_id int id заказа в системе

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok",
"order_id":"111111"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
order_id int id заказа в системе

Ошибочный ответ

{
  "result":"error",
  "message": Неверный статус заказа
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Оплатить заказ

https://miratext.ru/api2/call/order/accept

Параметры запроса:

Параметр Тип Описание
order_id int id заказа в системе
rating int оценка копирайтера за заказ
description string отзыв в профиле копирайтера (если передается отзыв, то обязательно должна передаваться оценка rating)
add_amount float Дополнительное денежное вознаграждение для автора

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok",
"order_id":"111111"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
order_id int id заказа в системе

Ошибочный ответ

{
  "result":"error",
  "message": Неверный статус заказа
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Изменить оценку и отзыв

https://miratext.ru/api2/call/order/edit_rating

Параметры запроса:

Параметр Тип Описание
order_id int id заказа в системе
rating int оценка копирайтера за заказ
description string отзыв в профиле копирайтера
add_amount float Дополнительное денежное вознаграждение для автора

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok",
"order_id":"111111"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
order_id int id заказа в системе

Ошибочный ответ

{
  "result":"error",
  "message": Неверный статус заказа
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Отправить завершенный заказ в архив

https://miratext.ru/api2/call/order/sendToArchive

Параметры запроса:

Параметр Тип Описание
order_id int id заказа в системе

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok",
"order_id":"111111"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
order_id int id заказа в системе

Ошибочный ответ

{
  "result":"error",
  "message": Неверный статус заказа
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Вернуть архивный заказ в активный

https://miratext.ru/api2/call/order/returnFromArchive

Параметры запроса:

Параметр Тип Описание
order_id int id заказа в системе

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok",
"order_id":"111111"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
order_id int id заказа в системе

Ошибочный ответ

{
  "result":"error",
  "message": Неверный статус заказа
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Удалить заказ

https://miratext.ru/api2/call/order/delete

Параметры запроса:

Параметр Тип Описание
order_id int id заказа в системе

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok",
"order_id":"111111"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
order_id int id заказа в системе

Ошибочный ответ

{
  "result":"error",
  "message": Ошибка
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Продлить срок заказа

https://miratext.ru/api2/call/order/changeDateWorkingClosing

Параметры запроса:

Параметр Тип Описание
order_id int id заказа в системе
working_period int время исполнения

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok",
"order_id":"111111"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
order_id int id заказа в системе

Ошибочный ответ

{
  "result":"error",
  "message": Ошибка
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Проекты

Создать проект

https://miratext.ru/api2/call/project/create

Параметры запроса:

Параметр Тип Описание
title string Название проекта (обязательный параметр)
description string Описание проекта.
wateriness int Водянистость.
workers_count int Сколько заказов может выполнить каждый копирайтер.
stop_words string Cтоп-слова (слова или словосочетания через запятую)

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok",
"project_id":"1111"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
project_id int id проекта в системе

Ошибочный ответ

{
  "result":"error",
  "message": Ошибка
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Редактировать проект

https://miratext.ru/api2/call/project/edit

Параметры запроса:

Параметр Тип Описание
id int id проекта в системе (обязательный параметр)
title string Название проекта (обязательный параметр)
description string Описание проекта.
wateriness int Водянистость.
workers_count int Сколько заказов может выполнить каждый копирайтер.
stop_words string Cтоп-слова (слова или словосочетания через запятую)

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok",
"project_id":"1111"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
project_id int id проекта в системе

Ошибочный ответ

{
  "result":"error",
  "message": Ошибка
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Список проектов

https://miratext.ru/api2/call/project/list

Параметры запроса:

Параметр Тип Описание
project_id array массив id проектов в системе

Метод возвращает следующие параметры:

Успешный ответ

		{
		  "result":"ok",
		  "projects":[{project1},{project2},...]
		}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
projects array массив проектов

Каждый проект содержит массив Project.

Поля в массиве Project
Параметр Тип Описание
id int id проекта в системе
title string Название проекта
description string Описание проекта.
wateriness int Водянистость.
workers_count int Сколько заказов может выполнить каждый копирайтер.
stop_words string Cтоп-слова (слова или словосочетания через запятую)

Удалить проект

https://miratext.ru/api2/call/project/delete

Параметры запроса:

Параметр Тип Описание
project_id int id проекта в системе

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok",
"project_id":"1111"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
project_id int id проекта в системе

Ошибочный ответ

{
  "result":"error",
  "message": Ошибка
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Пользователи

Баланс пользователя

https://miratext.ru/api2/call/user/balance

Метод возвращает следующие параметры:

Успешный ответ

		{
		  "result":"ok",
		  "free":"1000",
		  "phold":"1000",
		  "nhold":"1000",
		  "nvirtual":"1000"
		}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
free float на счету
nhold float передается
nvirtual float планируется
phold float ожидается

История платежей

https://miratext.ru/api2/call/user/payments_history

Параметры запроса:

Параметр Тип Описание
s_start_date date С даты (включительно)
s_end_date date До даты (включительно)

Метод возвращает следующие параметры:

Успешный ответ

		{
		  "result":"ok",
		  "projects":[{project1},{project2},...]
		}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
payments array массив платежей [payment1, payment2, payment3, ...]
Поля в массиве payment
Параметр Тип Описание
id int id платежа в системе
date date Дата
type string Тип платежа

допустимые значения:
'hold' - 'Заморожено',
'pay' - 'Оплата',
'add' - 'Пополнение',
'withdraw' - 'Вывод',
'refbonus' - 'Реф. бонус',
'canceled' - 'Отмененный'
amount float Сумма, руб.
project string Проект
message string Комментарий

Копирайтеры

Список копирайтеров

https://miratext.ru/api2/call/worker/list

Параметры запроса:

Параметр Тип Описание
worker_id array массив id копирайтеров в системе

Метод возвращает следующие параметры:

Успешный ответ

		{
		  "result":"ok",
		  "workers":[{worker1},{worker2},...]
		}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
workers array массив копирайтеров

Каждый заказ содержит массив Worker.

Поля в массиве Worker
Параметр Тип Описание
id int id копирайтера в системе
status_worker string статус

допустимые значения:
'available' - 'свободен',
'busy' - 'занят',
'vacation' - 'в отпуске',
'hidden' - 'скрыт из каталога',
title string Имя копирайтера
rating string Рейтинг копирайтера
age int Возраст
sex string Пол

допустимые значения:
'male' - 'мужчина',
'female' - 'женщина',
avatar string Url картинки
worker_description string Полное резюме
worker_description_snippet string Краткое резюме
date_registered date Дата регистрации
rating_positive int Число положительных отзывов
rating_negative int Число отрицательных отзывов
customer_rating float Средняя оценка заказчика
corrector_rating float Средняя оценка копирайтера
offered_copywrite_price_filter float Цена за копирайтинг
offered_rewrite_price_filter float Цена за рерайтинг

Профиль копирайтера

https://miratext.ru/api2/call/worker/view

Параметры запроса:

Параметр Тип Описание
worker_id int id копирайтера в системе

Метод возвращает следующие параметры:

Успешный ответ

		{
		  "result":"ok",
		  "worker":[]
		}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
worker array Информация о копирайтере

worker может содержать массивы Worker, Ratings, Thematic, Portfolio, Userlist.

Поля в массиве Worker
Параметр Тип Описание
id int id копирайтера в системе
status_worker string статус

допустимые значения:
'available' - 'свободен',
'busy' - 'занят',
'vacation' - 'в отпуске',
'hidden' - 'скрыт из каталога',
title string Имя копирайтера
rating string Рейтинг копирайтера
age int Возраст
sex string Пол

допустимые значения:
'male' - 'мужчина',
'female' - 'женщина',
avatar string Url картинки
worker_description string Полное резюме
worker_description_snippet string Краткое резюме
date_registered date Дата регистрации
rating_positive int Число положительных отзывов
rating_negative int Число отрицательных отзывов
customer_rating float Средняя оценка заказчика
corrector_rating float Средняя оценка копирайтера
offered_copywrite_price_filter float Цена за копирайтинг
offered_rewrite_price_filter float Цена за рерайтинг
note string Заметка
total_orders int Выполнено работ
abandon_works int Количество брошенных работ
reworking_orders int Количество просрочек
shop_articles_sold int Проданные статьи
worker_in_white_list int Добавили в белый список
worker_in_black_list int Добавили в черный список
date_active date Дата активности
total_orders_my int Выполнено работ (персональная статистика)
working_orders_my int В работе сейчас (персональная статистика)
checking_orders_my int На проверке (персональная статистика)
offered_orders_my int Предложено (персональная статистика)
reworking_orders_my int Количество доработок (персональная статистика)
Поля в массиве Ratings
Параметр Тип Описание
title string имя заказчика, который оставил отзыв
rating int оценка
description string отзыв
date_created date дата отзыва
Поля в массиве Thematic (тематики копирайтера)
Параметр Тип Описание
title string Тематка
percent int Процент
Поля в массиве Portfolio (портфолио копирайтера)
Параметр Тип Описание
title string Title
description string Description
Поля в массиве Userlist (списки пользователей, в которые входит копирайтер)
Параметр Тип Описание
title string Список

Сообщения

Сообщение по заказу

https://miratext.ru/api2/call/message/addInOrder

Параметры запроса:

Параметр Тип Описание
order_id int id заказа в системе (обязательный параметр)
message string Сообщение (обязательный параметр)

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'

Ошибочный ответ

{
  "result":"error",
  "message": Ошибка
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Прикрепление файлов к заказу

https://miratext.ru/api2/call/message/addAttachInOrder

Параметры запроса:

Параметр Тип Описание
order_id int id заказа в системе (обязательный параметр)
files array массив файлов [file1, file2, file3, ...]
Поля в массиве file
Параметр Тип Описание
name string имя файла
data string файл закодированный в base64

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'

Ошибочный ответ

{
  "result":"error",
  "message": Ошибка
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Сообщение копирайтеру

https://miratext.ru/api2/call/message/add

Параметры запроса:

Параметр Тип Описание
worker_id int id копирайтера в системе (обязательный параметр)
subject string Тема (обязательный параметр)
message string Сообщение (обязательный параметр)

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'

Ошибочный ответ

{
  "result":"error",
  "message": Ошибка
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Отправка файлов в сообщении

https://miratext.ru/api2/call/message/addAttach

Параметры запроса:

Параметр Тип Описание
worker_id int id копирайтера в системе (обязательный параметр)
files array массив файлов [file1, file2, file3, ...]
Поля в массиве file
Параметр Тип Описание
name string имя файла
data string файл закодированный в base64

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'

Ошибочный ответ

{
  "result":"error",
  "message": Ошибка
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Сообщение по беззаботному проекту

https://miratext.ru/api2/call/message/addInCarefreeProject

Параметры запроса:

Параметр Тип Описание
carefree_project_id int id беззаботного проекта в системе (обязательный параметр)
message string Сообщение (обязательный параметр)

Метод возвращает следующие параметры:

Успешный ответ

{
"result":"ok"
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'

Ошибочный ответ

{
  "result":"error",
  "message": Ошибка
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Инструменты

Анализ текста

https://miratext.ru/api2/call/article/seoAnalizText

Параметры запроса:

Параметр Тип Описание
check_type text тип проверки:
'url' - URL,
'content' - Текст,
shop_type text тип проверки:
'normal' - Обычные сайты,
'keywords_search' - Поисковая выдача + анализ сайтов,
content array массив текстов для анализа [text1, text2, ...].
используется, если check_type = 'content'
url array массив url для анализа [url1, url2, ...].
используется, если check_type = 'url'
my string URL или текст для сравнения
options array параметры проверки
keywords_search array параметры проверки для shop_type="keywords_search"
hash string id анализа (используется для получения результатов анализа)
Поля в массиве options
Параметр Тип Описание
use_no_index boolean не учитывать текст в теге noindex (по умолчанию true)
ignore_alt_title boolean Не учитывать атрибуты alt и title (по умолчанию true)
ignore_digits boolean Не учитывать цифры (по умолчанию true)
ignore_predlogs boolean Не учитывать союзы, предлоги и местоимения (по умолчанию true)
ignore_words boolean Не учитывать список слов (только прямые вхождения) (по умолчанию true)
ignored_words string список слов (по умолчанию: рублей, руб, стр, ул, шт, см, мм, мл, кг, кв)
paid_type string бесплатный/платный анализ:
'free' - бесплатный анализ (по умолчанию),
'paid' - платный анализ,
Поля в массиве keywords_search
Параметр Тип Описание
keywords string Ключевые запросы
search_type string Поисковая система (по умолчанию yandex)
region_id int Регион (по умолчанию Москва)
ignore_domains boolean Не учитывать список сайтов (игнорировать сайты в поисковой выдаче) (по умолчанию true)
ignored_domains string список сайтов (по умолчанию: yandex.ru, avito.ru, ya.ru, cian.ru, 2gis.ru, vk.com, superjob.ru, hh.ru, youtube.com, tutu.ru, wikipedia.org, travelata.ru, dzen.ru, ok.ru, academic.ru, otzovik.com, irecommend.ru, ozon.ru, t.me, citilink.ru, mvideo.ru, dns-shop.ru, wildberries.ru, mail.ru, sravni.ru, aliexpress.ru, auto.ru, drom.ru, drive2.ru, youla.ru, google.com, zoon.ru, gosuslugi.ru, rambler.ru, gismeteo.ru, google.ru, pikabu.ru, prodoctorov.ru, domclick.ru, profi.ru, yell.ru, rutube.ru, tripadvisor.ru, flamp.ru, spr.ru, yell.ru, yelp.com, tulp.ru, apoi.ru, vseotzyvy.ru, kupilskazal.ru, imho24.ru, otzyv.com, spasibovsem.ru, sites.reviews, price.ru, pulscen.ru, tiu.ru, aport.ru, 4geo.ru, rosfirm.ru, maxi-karta.ru, spravka.me, allinform.ru, spravker.ru, orgpage.ru, ypag.ru, foursquare.com, all.biz, altergeo.ru, gmstar.ru, toster.ru, ask.fm, twoo.com, thequestion.ru, genon.ru)

Метод возвращает следующие параметры:

Успешный ответ

Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
status string статус выполнения анализа
допустимые значения:
'draft' - в очереди,
'working' - обрабатывается,
'accepted' - завершено,
hash string id анализа
drafts int количество проверок в очереди (выводится, если статус не 'accepted')
data array данные (выводится, если статус 'accepted')
Поля в массиве data
Параметр Тип Описание
myStats array статистика URL или текста для сравнения (если есть)
stats array статистика
titleStats array статистика тайтлов
descriptionStats array статистика дескрипшинов
repeatWordsAll array таблица найденных слов
repeatWords2All array таблица повторений (словосочетание из двух слов)
repeatWords3All array таблица повторений (словосочетание из трех слов)
hTags array структура заголовков и подзаголовков на страницах
tz array слова для технического задания
characteristics array таблица характеристик (если shop_type = 'wildberries' или 'ozon')
analysContents array анализ отдельных страниц/текстов [analysContent1, analysContent2, ...]
Поля в массиве myStats
Параметр Тип Описание
url string url (если проверялся url)
wordsData array статистика по словам
length int Количество символов с пробелами
lengthTrim int Количество символов без пробелов
wordsCount int Количество слов
wordsRootCount int Количество уникальных слов
nausea int Тошнота
zypfa int Качество текста по закону Ципфа
wateriness int Водянистость
title array
Поля в массиве
Параметр Тип Описание
text string title
length int Количество символов с пробелами
wordsCount int Количество слов
repeatWordsAll array таблица найденных слов
description array
Поля в массиве
Параметр Тип Описание
text string description
length int Количество символов с пробелами
wordsCount int Количество слов
repeatWordsAll array таблица найденных слов
Поля в массиве stats
Параметр Тип Описание
length array Количество символов с пробелами
Поля в массиве
Параметр Тип Описание
data array массив значений в каждом тексте/url [1, 2, 3, ...]
stat array массив статистических значений [moda, mediana, avg]
lengthTrim array Количество символов без пробелов
Поля в массиве
Параметр Тип Описание
data array массив значений в каждом тексте/url [1, 2, 3, ...]
stat array массив статистических значений [moda, mediana, avg]
wordsCount array Количество слов
Поля в массиве
Параметр Тип Описание
data array массив значений в каждом тексте/url [1, 2, 3, ...]
stat array массив статистических значений [moda, mediana, avg]
wordsRootCount array Количество уникальных слов
Поля в массиве
Параметр Тип Описание
data array массив значений в каждом тексте/url [1, 2, 3, ...]
stat array массив статистических значений [moda, mediana, avg]
nusea array тошнота
Поля в массиве
Параметр Тип Описание
data array массив значений в каждом тексте/url [1, 2, 3, ...]
stat array массив статистических значений [moda, mediana, avg]
wateriness array Водянистость
Поля в массиве
Параметр Тип Описание
data array массив значений в каждом тексте/url [1, 2, 3, ...]
stat array массив статистических значений [moda, mediana, avg]
zypfa array Анализ текста по закону Ципфа
Поля в массиве
Параметр Тип Описание
data array массив значений в каждом тексте/url [1, 2, 3, ...]
stat array массив статистических значений [moda, mediana, avg]
wordsAnkorsCount array Количество слов в ссылках
массив значений в каждом тексте/url [1, 2, 3, ...]
wordsNoAnkorsCount array Количество слов не в ссылках
массив значений в каждом тексте/url [1, 2, 3, ...]
repeatWordsAllTfIdfCloud array Облако слов: текст и ссылки
NoAnkorsWordsAllTfIdfCloud array Облако слов: зона текста
AnkorsWordsAllTfIdfCloud array Облако слов: зона ссылок
medianaWords array Cамые популярные слова
medianaDensityWords array Cамые популярные слова по плотности
titleDescriptionAllCustomRoots array слова в title и description [word1, word2, word3, ...]
Поля в массиве
Параметр Тип Описание
word string Слово
wordsAll array Слова
words_count int Общее количество
title_count int Общее количество в title
description_count int Общее количество в description
title array массив значений в каждом тексте/url [1, 2, 3, ...]
description array массив значений в каждом тексте/url [1, 2, 3, ...]
titleStat array массив статистических значений [moda, mediana, avg]
descriptionStat array массив статистических значений [moda, mediana, avg]
Поля в массиве titleStats
Параметр Тип Описание
text array title
массив значений в каждом тексте/url [1, 2, 3, ...]
length array Количество символов с пробелами
массив значений в каждом тексте/url [1, 2, 3, ...]
lengthTrim array Количество слов
массив значений в каждом тексте/url [1, 2, 3, ...]
lengthStat array массив статистических значений [moda, mediana, avg]
wordsCountStat array массив статистических значений [moda, mediana, avg]
Поля в массиве descriptionStats
Параметр Тип Описание
text array description
массив значений в каждом тексте/url [1, 2, 3, ...]
length array Количество символов с пробелами
массив значений в каждом тексте/url [1, 2, 3, ...]
lengthTrim array Количество слов
массив значений в каждом тексте/url [1, 2, 3, ...]
lengthStat array массив статистических значений [moda, mediana, avg]
wordsCountStat array массив статистических значений [moda, mediana, avg]
Поля в массиве repeatWordsAll
Параметр Тип Описание
word string Слово
wordsAll array Слова
popularity float популярность
count int повторений
words_count array массив значений в каждом тексте/url [1, 2, 3, ...]
density array массив значений в каждом тексте/url [1, 2, 3, ...]
no_ankors array зона текста
массив значений в каждом тексте/url [1, 2, 3, ...]
ankors array зона ссылок
массив значений в каждом тексте/url [1, 2, 3, ...]
words_count_stat array массив статистических значений [moda, mediana, avg]
density_stat array массив статистических значений [moda, mediana, avg]
no_ankors_stat array массив статистических значений [moda, mediana, avg]
ankors_stat array массив статистических значений [moda, mediana, avg]
Поля в массивах repeatWords2All, repeatWords3All
Параметр Тип Описание
words array массив фраз
root_words array фраза
popularity float популярность
count int сайты
words_count array массив значений в каждом тексте/url [1, 2, 3, ...]
density array массив значений в каждом тексте/url [1, 2, 3, ...]
words_count_stat array массив статистических значений [moda, mediana, avg]
density_stat array массив статистических значений [moda, mediana, avg]
Поля в массиве tz
Параметр Тип Описание
keywordsAll array Слова, у которых рекомендуемое количество вхождений в зоне "Текст + Ссылки" >=1
Параметр Тип Описание
word string Слово
density float Медиана плотности
site_count int Сайты
min_density float Минимальная плотность
max_density float Максимальная плотность
my_count int Найдено
recomended_my int Требуется (на основании объема сравниваемой страницы)
recomended int Требуется (на основании медианы конкурентов)
keywordsDensityDeviation array Слова с отклонением по плотности
Параметр Тип Описание
word string Слово
density float Медиана плотности
site_count int Сайты
min_density float Минимальная плотность
max_density float Максимальная плотность
my_count int Найдено
recomended_my int Требуется (на основании объема сравниваемой страницы)
recomended int Требуется (на основании медианы конкурентов)
Поля в массиве characteristics
Параметр Тип Описание
название характеритики array значения характеристики
Параметр Тип Описание
word string Слово
wordsAll array Слова
count int повторений
words_count array массив значений в каждом url [1, 2, 3, ...]
Поля в массиве analysContent
Параметр Тип Описание
wordsData array статистика по словам
Поля в массиве wordsData
Параметр Тип Описание
length int Количество символов с пробелами
lengthTrim int Количество символов без пробелов
wordsCount int Количество слов
repeatWordsAll array Таблица найденных слов
repeatWords2All array Количество повторений (словосочетание из двух слов)
repeatWords3All array Количество повторений (словосочетание из трех слов)
stopWords array Водянистость
nusea array тошнота
zypfa array Анализ текста по закону Ципфа
Поля в массиве nusea
Параметр Тип Описание
value float "Тошнота" текста
words array
Поля в массиве
Параметр Тип Описание
word string Слово
count int повторений
density float плотность
Поля в массиве zypfa
Параметр Тип Описание
value float Качество текста по закону Ципфа
wordstat array
Поля в массиве
Параметр Тип Описание
words array Все словоформы слова
count int Вхождений
zypf int По Ципфу

Ошибочный ответ

{
  "result":"error",
  "message": Ошибка
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки

Проверка текста на вхождение ключевых слов

https://miratext.ru/api2/call/article/keywordsChecker

Параметры запроса:

Параметр Тип Описание
hash string id анализа (используется для получения результатов анализа)
check_type text тип проверки:
'url' - URL,
'content' - Текст,
content string используется, если check_type = 'content'
direct_keywords array Точное и другие
массив фраз для анализа [direct_keywords1, direct_keywords2, ...].
direct_keyword_template string шаблон для "Точное и другие": "keyword", "keyword()", "keyword[]", "keyword-", "keyword,"
direct_occurrences_keywords_accurate boolean точное вхождение (по умолчанию true)
direct_occurrences_keywords_clear boolean чистое вхождение (по умолчанию true)
direct_occurrences_keywords_direct boolean прямое вхождение (по умолчанию true)
indirect_keywords array Разбавленное и другие
массив фраз для анализа [indirect_keywords1, indirect_keywords2, ...].
indirect_keyword_template string шаблон для "Разбавленное и другие": "keyword", "keyword()", "keyword[]", "keyword-", "keyword,"
indirect_occurrences_keywords_diluted boolean разбавленное вхождение (по умолчанию true)
indirect_occurrences_keywords_morphological boolean морфологическое вхождение (по умолчанию true)
indirect_occurrences_keywords_morphological_diluted boolean морфологическое разбавленное (по умолчанию true)
indirect_occurrences_keywords_reverse boolean обратное вхождение (по умолчанию true)
indirect_occurrences_keywords_reverse_diluted boolean обратное разбавленное вхождение (по умолчанию true)
indirect_occurrences_keywords_morphological_diluted_complicated boolean сложное вхождение (по умолчанию true)
lsi_keywords array Любое вхождение
массив фраз для анализа [lsi_keywords1, lsi_keywords2, ...].
lsi_keyword_template string шаблон для "Любое вхождение": "keyword", "keyword()", "keyword[]", "keyword-", "keyword,"
lsi_keywords_accurate boolean точное вхождение (по умолчанию true)
lsi_keywords_clear boolean чистое вхождение (по умолчанию true)
lsi_keywords_direct boolean прямое вхождение (по умолчанию true)
lsi_keywords_diluted boolean разбавленное вхождение (по умолчанию true)
lsi_keywords_morphological boolean морфологическое вхождение (по умолчанию true)
lsi_keywords_morphological_diluted boolean морфологическое разбавленное (по умолчанию true)
lsi_keywords_reverse boolean обратное вхождение (по умолчанию true)
lsi_keywords_reverse_diluted boolean обратное разбавленное вхождение (по умолчанию true)
lsi_keywords_morphological_diluted_complicated boolean сложное вхождение (по умолчанию true)
analys_type_search text Как искать слова:
'not_unique_by_keyword' - Разовые вхождения,
'not_unique_by_keyword_all' - Пересечение вхождений,
'unique_by_keyword' - Уникальные вхождения,
use_no_index boolean не учитывать текст в теге noindex (по умолчанию true)
ignore_words boolean Не учитывать список слов (только прямые вхождения) (по умолчанию true)
ignored_words string список слов (по умолчанию: рублей, руб, стр, ул, шт, см, мм, мл, кг, кв)

Метод возвращает следующие параметры:

Успешный ответ

Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
hash string id анализа
direct_keywords array массив ключей с результатами анализа [keyword1, keyword2, ...]
indirect_keywords array массив ключей с результатами анализа [keyword1, keyword2, ...]
lsi_keywords array массив ключей с результатами анализа [keyword1, keyword2, ...]
Поля в массиве keyword
Параметр Тип Описание
keyword string Фраза
orirginal string Оригинальная фраза (с цифрой в шаблоне)
count int Вхождений требуется
find int Вхождений найдено
findDensity float Плотность

Ошибочный ответ

{
  "result":"error",
  "message": Ошибка
}
Параметр Тип Описание
result string результат выполнения операции 'ok' или 'error'
message string Текст ошибки