Входные параметры:

• text - проверяемый текст на уникальность от 100 до 150000 символов (обязательный);
• userkey - ваш персональный секретный ключ (обязательный);
• exceptdomain - домены, которые вы хотите исключить из проверки. Домены разделяются пробелами или запятыми. Допускается использование символа * для обозначения произвольной части. Например: example.ru, *.example.ru (необязательный);
• excepturl - ссылки, которые вы хотите исключить из проверки. Ссылки разделяются пробелами или запятыми. Допускается использование символа * для обозначения произвольной части. Например: https://example.ru/category/* (необязательный);
• visible - доступность результатов проверки другим пользователям. По-умолчанию - результаты проверки (https://text.ru/antiplagiat/{your_text_uid}) доступны только вашему аккаунту. Если вы хотите, чтобы результаты проверок были открыты, необходимо передать значение vis_on (необязательный);
• copying - если вы не хотите, чтобы формировалась ссылка с визуальным оформлением результатов проверки https://text.ru/antiplagiat/{your_text_uid}, то необходимо передать значение noadd (необязательный);
• callback - ваш URL (ссылка), на которую мы отправим POST-запрос с результатами проверки сразу же после её окончания. Подробности указаны ниже (необязательный).

Выходные параметры:

Если текст успешно добавился, возвращается один параметр:

• text_uid - уникальный идентификатор текста. Используется при последующем получении результатов проверки.

В случае возникновения ошибки возвращаются следующие параметры:

• error_code - код ошибки;
• error_desc - описание ошибки.

$body = [
    'userkey' => '<USERKEY>',
    // Проверяемый текст
    'text' => '<TEXT>',
    // Ссылка, на которую нужно отправить результат проверки
    'callback' => 'https://your-site.com/callback',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.text.ru/post');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, \json_encode($body));

$rawResponse = curl_exec($ch);

if (curl_errno($ch)) {
    throw new \Exception('Ошибка curl: ' . curl_error($ch));
}

curl_close($ch);

$response = \json_decode($rawResponse, true);

print_r($response); // ['text_uid' => '63c129651c171']

const axios = require('axios');

const client = axios.create({
    baseURL: 'https://api.text.ru'
});

const body = {
    userkey: '<USERKEY>',
    // Проверяемый текст
    text: '<TEXT>',
    // Ссылка, на которую нужно отправить результат проверки
    callback: 'https://your-site.com/callback'
};

client
    .post('/post', body)
    .then((response) => {
        console.log(response.data);
    })
    .catch((err) => {
        console.error(err);
    })
;

Входные параметры:

• uid - уникальный идентификатор текста. Берется из метода addText (обязательный);
• userkey - ваш персональный секретный ключ (обязательный);
• jsonvisible (необязательный) - параметр позволяет получить более детальную информацию о результатах проверки. Возможные значения:

  detail

  В ответ будут добавлены words и clear_text (см. структуру result_json).

  detail_view

  Параметр является экспериментальным.
  

  То же, что и detail, но вместо clear_text в корень ответа будут добавлены параметры text_view и words_pos.

  text_view — версия текста с сохраненной структурой и пунктуацией. Соответствует тексту, который отображается в форме на сайте.
  words_pos — список позиций слов в text_view. Номер в списке соответствует номеру слова в words. Каждая позиция представлена парой чисел — начальным и конечным смещением слова в тексте. Отсчет начинается с 0, оба смещения включительны и указаны в символах.

Выходные параметры:

Если текст успешно проверен, возвращаются два параметра:

• text_unique - уникальность текста в процентах с точностью до 2 знаков после запятой;
• result_json - дополнительная информация о результатах проверки на уникальность в формате json. Структура json-ответа расшифрована ниже;
• spell_check - (доступен с опцией jsonvisible) дополнительная информация о результатах проверки на правописание в формате json.
  Структура json-ответа расшифрована ниже;
• seo_check - (доступен с опцией jsonvisible) дополнительная информация о результатах проверки на SEO-анализ в формате json.
  Структура json-ответа расшифрована ниже.

Если текст ещё не проверился или произошла ошибка при проверке, возвращаются следующие параметры:

• error_code - код ошибки;
• error_desc - описание ошибки.

$body = [
    'userkey' => '<USERKEY>',
    'uid' => '<UID>',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.text.ru/post');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, \json_encode($body));

$rawResponse = curl_exec($ch);

if (curl_errno($ch)) {
    throw new \Exception('Ошибка curl: ' . curl_error($ch));
}

curl_close($ch);

$response = \json_decode($rawResponse, true);

print_r($response);

const axios = require('axios');

const client = axios.create({
    baseURL: 'https://api.text.ru'
});

const body = {
    userkey: '<USERKEY>',
    uid: '<UID>'
};

client
    .post('/post', body)
    .then((response) => {
        console.log(response.data);
    })
    .catch((err) => {
        console.error(err);
    })
;

• date_check - дата окончания проверки текста на сервере;
• unique - уникальность текста в процентах, с точностью до 2 знаков после запятой;
• urls - массив ссылок, для которых известно:
  • url - текст ссылки;
  • plagiat - процент совпадения текста по ссылке;
  • words - (доступен с опцией jsonvisible) номера позиций "совпадающих" слов в тексте (clear_text - см. ниже). Нумерация начинается с 0.
• clear_text - (доступен с опцией jsonvisible) очищенный от служебных символов и знаков препинания ваш текст, состоящий из слов, разделенных через пробел.

Посмотреть пример JSON-ответа

Проверка текста на правописание работает параллельно и независимо с проверкой на уникальность. К примеру, текст может провериться на правописание раньше, чем на уникальность. В этом случае результаты по правописанию уже будут доступны в ответе, в то время как для получения результатов проверки на уникальность понадобятся дополнительные запросы.

Проверка на правописание гарантированно не может найти все ошибки. Мы постоянно работаем над улучшением алгоритма. С примерами его работы вы можете ознакомиться в бесплатной версии через форму на сайте.

Если проверка на правописание ещё не завершена, то параметр spell_check будет равен пустой строке.
По завершению проверки параметр spell_check примет json-представление массива, элементы которого состоят из:

• error_type - тип ошибки ('Орфография', 'Пунктуация' и т.д.);
• reason - детальное описание ошибки;
• error_text - текст фрагмента, в котором обнаружилась ошибка;
• replacements - массив с предлагаемыми вариантами замены (может быть пустым);
• start - начальная позиция фрагмента, в котором найдена ошибка;
• end - конечная позиция фрагмента, в котором найдена ошибка.

Посмотреть пример JSON-ответа

Проверка текста на SEO-анализ работает параллельно, как и проверка текста на правописание. Текст на SEO-анализ может провериться раньше, чем на уникальность. В этом случае для получения результатов проверки на уникальность понадобятся дополнительные запросы до готовности ответа от API.

Если проверка на SEO-анализ ещё не завершена, то параметр seo_check будет равен пустой строке.
По завершению проверки параметр seo_check примет следующее json-представление:

• count_chars_with_space - количество символов с пробелами;
• count_chars_without_space - количество символов без пробелов;
• count_words - количество слов в тексте;
• water_percent - процент воды;
• spam_percent - процент заспамленности;
• mixed_words - номера позиций слов в тексте, у которых присутствуют символы из разных алфавитов и имеющих схожее написание. Нумерация начинается с 0.
• list_keys - список ключей в тексте, отсортированных по частоте встречаемости:
  • key_title - текст ключа;
  • count - количество вхождений ключа в текст во всех формах.
• list_keys_group - список ключей в тексте, отсортированных по числу значимых слов и сгруппированных по составу слов:
  • key_title - текст ключа;
  • count - количество вхождений ключа в текст во всех формах.
  • sub_keys - список подключей:
  • key_title - текст подключа;
  • count - количество вхождений подключа в текст во всех формах.

Посмотреть пример JSON-ответа

Проверка текста на уникальность занимает определенное (заранее неизвестное) время. Если вы хотите получить уведомление о факте завершения (вместе с результатами) проверки вашего текста, то вы можете при добавлении текста на API в параметре callback указать адрес вашего скрипта, который обработает наш POST-запрос с результатами проверки текста.

• Чтобы убедиться, что вы успешно получили результат, на вашей странице должно отобразиться ok и ничего более (echo "ok";).
• Максимальное число попыток отправки результатов проверки - 3.
• В callback POST-запросе отправляются 4 параметра: uid, text_unique, json_result, spell_check. Структура json-ответа такая же, что и при ручном запросе результата (без атрибутов clear_text и words).
• Если проверка на правописание закончится позже проверки на уникальность, то будет отправлено 2 callback-запроса по мере окончания проверок (во время первого запроса параметр spell_check будет равен пустой строке).
• Получить результаты проверки на уникальность также можно и вручную.

Адрес для запроса: http://api.text.ru/account

POST-параметры запроса:

• method - 'get_packages_info' (обязательный);
• userkey - ваш персональный секретный ключ (обязательный);

Результат запроса (в формате json):

• size - суммарный остаток символов по всем пакетам;

Внимание! В целях безопасности, чтобы ваш IP-адрес не заблокировался, не рекомендуется обращаться к данному методу чаще 2 раз в минуту.

$body = [
    'userkey' => '<USERKEY>',
    'method' => 'get_packages_info',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.text.ru/account');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, \json_encode($body));

$rawResponse = curl_exec($ch);

if (curl_errno($ch)) {
    throw new \Exception('Ошибка curl: ' . curl_error($ch));
}

curl_close($ch);

$response = \json_decode($rawResponse, true);

print_r($response); // ['size' => 1000]

const axios = require('axios');

const client = axios.create({
    baseURL: 'https://api.text.ru'
});

const body = {
    userkey: '<USERKEY>',
    method: 'get_packages_info'
};

client
    .post('/account', body)
    .then((response) => {
        console.log(response.data);
    })
    .catch((err) => {
        console.error(err);
    })
;