Общее об API

Понятия

• «Источник» — это любой источник, из которого приходят данные на проверку. Источником может быть группа, комментарии на сайте, комментарии на канале и т.д. Источник — условный объект, но не столько для удобства, сколько для учета и управления. Так, например, вы можете для проверки комментариев с сайта «А» создать источник под названием «comments_A«, а для проверки публикаций с сайта «А» создать источник под названием «posts_A«. Такое разделение лучше, чем все в один источник «site_A«, поскольку появляется раздельный учет расходов, возможность отключить проверку постов без отключения проверки комментариев, подключение разных словарей и так далее.
• «Главный токен» используется для идентификации пользователя во всех запросах без исключения. Его можно изменить только вручную с панели управления сайта. В запросе к основному узлу /api/ , в значении версии API допускаются только цифры "0-9", латинские буквы "a-z" и "A-Z", знак подчеркивания "_". Пример: [main_token] => 'PD1k0qeo123j4rJ'.
• «Основной узел» — основным узлом обращения всех внешних запросов к API является /api/.

Запросы

Только POST-запросы в формате JSON принимаются скриптом. Вы можете передать application/json данные, исключая загрузки файлов.

Указание версии API

Настоятельно рекомендуем указывать версию API, к которой обращается ваш скрипт, потому что в ином случае на нашей стороне будет использована последняя актуальная версия, что может вызвать проблемы с получением ответа, корректностью обработки. В запросе к основному узлу /api/, в значении версии API допускаются только цифры "0-9", латинские буквы "a-z", знак подчеркивания "_". Пример: [api_version] => 'v1'.

Логика API

Основное действие определяется адресом запроса. Например, адрес /api/source/edit_tags определит, что нужно сделать (изменить метки источника), а параметры, переданные в JSON, например, [query_details]=>[source_tags]=>[add]=>[telegram, discord, personal] — уточнят детали как сделать (добавить/удалить/очистить) и с чем сделать (с метками telegram, discord, personal).

Версии API

API v1

Первая версия. Страница API v1.