Формат ответа — документация API
Ответ будет сформирован в формате, выбранном вами при запросе. По умолчанию мы отправляем ответ в формате .
При взаимодействии с API вы получите ответ в кодировке UTF-8.
Формат ответа при запросе баланса
| Название | Значение | Описание |
|---|---|---|
| balance | число | Ваш текущий баланс в формате «Р.К», где Р — количество рублей на вашем счету, К — количество копеек. Пример: 255.65 (на вашем счету 255 рублей и 65 копеек) |
| tariff | число | Ваш текущий тариф в формате «0.К». Пример: 0.50 (ваш тариф — 50 копеек за проверку) |
| user | E-mail, на который зарегистрирован ваш аккаунт в нашей системе |
Формат ответа в случае ошибки проверки
Если возникла ошибка, то вы получите ответ с единственным параметром «error». Этот праметр будет содержать текст ошибки, которая возникла.
| Название | Значение | Описание |
|---|---|---|
| error | строка | Текст ошибки, которая возникла при проверке |
Формат ответа в случае успешной проверки
| Название | Значение | Описание |
|---|---|---|
| error | пустая строка | — |
| text | строка | отправленный на проверку текст, очищенный для проверки нашим алгоритмом |
| percent | число от 0 до 100 с округлением до десятых |
результат проверки текста на уникальность |
| highlight | массив, каждый элемент — массив из двух целых чисел | массив пар номеров слов, которые были найдены среди плагиата (для суммарной подсветки совпадений, найденных на всех страницах) |
| matches | массив, каждый элемент — массив с тремя элементами | массив с информацией о страницах, на которых найдены совпадения |
Каждый элемент массива matches содержит следующие данные:
| Название | Значение | Описание |
|---|---|---|
| url | строка | адрес страницы, на которой найдены совпадения |
| percent | число от 0 до 100 с округлением до десятых |
процент длины исходного текста, найденный в контенте этой страницы |
| highlight | массив, каждый элемент — массив из двух целых чисел | массив пар номеров слов, которые были найдены на этой странице |
Параметр "highlight"
В ответе вы получите обработанный нашим алгоритмом предоставленный вами текст, очищенный от лишних символов. Вы можете подсветить на этом тексте те слова и фразы, которые мы нашли на других сайтах. Для этого используйте параметр "highlight".
Обратите внимание: подсвечивать совпавшие фразы нужно на тексте, который мы вам возвращаем при ответе, а не на том, который вы отправляете на проверку.
Пример простой функции на языке JavaScript, которая подсвечивает текст жирным шрифтом:
{
var words = text.split(" ");
for (var i = 0; i < hightlight.length; i++)
{
words[ hightlight[i][0] ] = '<strong>' + words[ hightlight[i][0] ];
words[ hightlight[i][1] ] = words[ hightlight[i][1] ] + '</strong>';
}
return words.join(" ");
}
Параметр matches["percent"]
Когда мы находим совпадения групп слов исходного текста на некоторой странице в Интернете, мы считаем суммарную длину всех совпавших слов и делим это значение на общую длину исходного текста. Таким образом мы получаем процент уникальности исходного текста относительно данной страницы. Суть этого значения в том, чтобы показать, какой объем исходного текста встретился на конкретной странице.
К примеру, значение 20.0 означает, что на этой странице встретилось 20% исходного текста.
Пожалуйста, подождите