Для проверки текста необходимо сформировать валидный запрос на адрес https://content-watch.ru/public/api/
Валидность запроса определяется наличием всех обязательных параметров, их верным содержимым, а также наличием у пользователя доступа к модулю API.
При взаимодействии с API необходимо использовать кодировку UTF-8.
Ваш ключ доступа — Подключите API
По мере расширения функционала API, мы решили добавить короткие примеры наборов параметров для выполнения разных действий, чтобы вам было проще внедрять обновления в ваши приложения.
Примеры можно посмотреть здесь.
Название | Тип параметра | Возможные значения | Значение по умолчанию | Описание | Варианты передачи |
---|---|---|---|---|---|
action | необязательный | CHECK_TEXT, CHECK_URL, GET_BALANCE | CHECK_TEXT | действие, нужное пользователю | параметр action GET-запроса параметр action POST-запроса |
key | обязательный | Подключите API | — | ваш ключ доступа, служащий для идентификации вас как пользователя | параметр key GET-запроса параметр key POST-запроса |
text | обязательный при action CHECK_TEXT |
валидный текст | — | проверяемый на уникальность текст ** | всё тело POST-запроса* параметр text POST-запроса |
ignore | необязательный | валидный URL | — | адрес сайта (домен), который нужно проигнорировать при проверке текста | параметр ignore GET-запроса параметр ignore POST-запроса |
url | обязательный при action CHECK_URL |
валидный URL | — | адрес страницы, проверяемой на уникальность | параметр url POST-запроса |
format | необязательный | json | json | формат ответа, который вы получите | параметр format GET-запроса параметр format POST-запроса |
test | необязательный | 1, 0 | 0 | при значении "1" вы получите ответ с фабрикованными данными. Текст проверен не будет, запрос не будет учитываться в статистике. Полезно для тестирования алгоритма разбора ответа | параметр test GET-запроса параметр test POST-запроса |
* Есть два варианта сформировать запрос:
** На проверяемый текст распространяются ограничения: до 15000 символов (рекомендуемая длина текста для максимизации качества проверки — 5000 символов). Минимальное количество слов в тексте — 15.