EzhikShieldAPI SDK Documentation

Интегрируйте мощные функции защиты от мошенничества в ваши Telegram-приложения с помощью EzhikShieldAPI SDK.

Скачайте SDK для вашей платформы

Маршруты EzhikShieldAPI

Важно: Для всех запросов необходимо указывать заголовок Authorization: TOKEN, где TOKEN — ваш API-токен.

1. /report

Отправляет жалобу на пользователя.

Method: POST
Endpoint: /report
Parameters:
  - creator_id: ID пользователя, который жалуется
  - user_id: ID пользователя, на которого подается жалоба
  - type: Тип жалобы (0 - Мошенник, 1 - Софтер, 2 - СПАМ, 3 - Агрессивный, 4 - Мультовод)

2. /pardon

Удаляет жалобу на пользователя.

Method: POST
Endpoint: /pardon
Parameters:
  - creator_id: ID пользователя, который удаляет жалобу
  - user_id: ID пользователя, с которого снимают жалобу

3. /check

Проверяет, есть ли жалобы на пользователя.

Method: GET
Endpoint: /check
Parameters:
  - user_id: ID пользователя, которого проверяют

4. /hasReported

Проверяет, подавал ли бот жалобу на пользователя.

Method: GET
Endpoint: /hasReported creator_id, user_id
Parameters:
  - creator_id: ID пользователя, который возможно подавал жалобу
  - user_id: ID пользователя, которого проверяют

Пример использования EzhikShieldAPI (NodeJS)

// Импортируем SDK
const EzhikShieldAPI = require('./EzhikShieldAPI');

// Создаем экземпляр API с токеном
const api = new EzhikShieldAPI('ВАШ_API_ТОКЕН');

// Отправляем жалобу на пользователя
async function reportUser(creator_id, user_id, type) {
    try {
        const result = await api.report(creator_id, user_id, type);
        console.log('Жалоба отправлена:', result);
    } catch (error) {
        console.error('Ошибка при отправке жалобы:', error);
    }
}

// Проверяем, есть ли жалобы на пользователя
async function checkUser(userId) {
    try {
        const result = await api.check(userId);
        console.log('Результат проверки:', result);
    } catch (error) {
        console.error('Ошибка при проверке пользователя:', error);
    }
}

// Использование функций
reportUser('12345, '54321', 0);  // Жалоба на пользователя с типом "Мошенник"
checkUser('54321');                   // Проверка на наличие жалоб