maxbot

Библиотека находится в разработке, доступен не весь функционал!

Rust-библиотека для создания ботов на платформе MAX
API: https://dev.max.ru/docs-api

Библиотека предоставляет удобный, асинхронный и типобезопасный интерфейс ко всем методам API MAX: отправка сообщений (с разбиением длинного текста), загрузка файлов, управление чатами и участниками, inline-клавиатуры, обработка callback-запросов, webhook/long polling и многое другое.

Важно: API MAX доступен только для российских юридических лиц и индивидуальных предпринимателей. Для получения токена бота обратитесь к документации MAX.

📦 Установка

Добавьте в Cargo.toml:

[dependencies]
maxbot = "0.1.0"
tokio = { version = "1", features = ["full"] }

🚀 Быстрый старт

1. Создайте клиент

use maxbot::MaxClient;

let token = std::env::var("MAXBOT_TOKEN").expect("Токен не найден");
let client = MaxClient::new(token);

2. Отправьте простое сообщение (Builder)

use maxbot::{MaxClient, SendMessageParamsBuilder};

let mids = client.send_message_builder(
    SendMessageParamsBuilder::new()
        .text("Привет, чат!")
        .chat_id(chat_id)
).await?;
println!("Сообщение отправлено, ID: {:?}", mids);

3. Отправьте сообщение с inline-клавиатурой и обработайте нажатие

use maxbot::{
    MaxClient, SendMessageParamsBuilder, Attachment,
    InlineKeyboardBuilder, InlineKeyboardButton, GetUpdatesParams,
};

// Отправка сообщения с клавиатурой
let keyboard = InlineKeyboardBuilder::new()
    .button(InlineKeyboardButton::link("е1.ru", "https://www.e1.ru"))
    .button(InlineKeyboardButton::callback("Щёлк!", "my_payload"))
    .build();

let mids = client.send_message_builder(
    SendMessageParamsBuilder::new()
        .text("Выбери действие:")
        .chat_id(chat_id)
        .attachment(Attachment::inline_keyboard(keyboard))
).await?;

// Ожидание callback
let params = GetUpdatesParams {
    marker: None,
    limit: Some(10),
    timeout: Some(30),
    types: vec!["message_callback".to_string()],
};
let (updates, _) = client.get_updates(params).await?;
for update in updates {
    if let Some(cb) = update.callback {
        // Ответ на нажатие: заменяем сообщение и показываем уведомление
        client.answer_callback_query(&cb.callback_id, new_message_json, Some("Нажато!")).await?;
    }
}

4. Отправка файла (изображения, видео, аудио, документа)

use maxbot::{Attachment, SendMessageParamsBuilder};

let builder = SendMessageParamsBuilder::new()
    .text("Вот изображение")
    .chat_id(chat_id)
    .attachment(Attachment::image_local("cat.jpg"));

client.send_message_builder(builder).await?;

🔒 Проксирование запросов через nginx (безопасное хранение токенов)

По умолчанию библиотека обращается напрямую к API MAX (https://platform-api.max.ru), и токен бота передаётся в заголовке Authorization каждого запроса. Это означает, что любой разработчик, имеющий доступ к исходному коду или переменным окружения, может увидеть токен.

Проблема: Токен бота — секретная информация. Если вы не хотите раскрывать его всем разработчикам или хранить в файлах конфигурации, можно развернуть собственный прокси-сервер (например, на базе nginx), который будет:

• Принимать запросы от ботов с базовой HTTP-аутентификацией (логин/пароль).
• Подменять заголовок Authorization на реальный токен бота MAX.
• Проксировать запросы к API MAX.

Преимущества:

• Разработчики работают только со своим личным логином/паролем, не зная токен бота.
• При увольнении сотрудника или при завершении им работы над проектом достаточно удалить его учётную запись на прокси-сервере.
• Токен бота хранится только на сервере с nginx.

Пример настройки nginx

Предположим, вы хотите использовать домен https://max.my-russian-company.ru как прокси.

1. Добавьте пользователей в файл .htpasswd:

htpasswd /etc/nginx/.htpasswd ivanov.i
htpasswd /etc/nginx/.htpasswd petrov.p

2. Создайте конфигурацию nginx (например, /etc/nginx/sites-available/max-proxy):

# Соответствие имён пользователей из .htpasswd токенам бота
map $remote_user $backend_token {
    default      "";
    "ivanov.i"   "реальный_токен_бота_1";
    "petrov.p"   "реальный_токен_бота_2";
}

server {
    listen 443 ssl;
    listen [::]:443 ssl;
    server_name max.my-russian-company.ru;

    ssl_certificate /etc/letsencrypt/live/my-russian-company.ru-0001/fullchain.pem;
    ssl_certificate_key /etc/letsencrypt/live/my-russian-company.ru-0001/privkey.pem;
    include /etc/letsencrypt/options-ssl-nginx.conf;
    ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem;

    auth_basic "Restricted access";
    auth_basic_user_file /etc/nginx/.htpasswd;

    location / {
        proxy_pass https://platform-api.max.ru;
        proxy_ssl_verify off;

        proxy_set_header Host platform-api.max.ru;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header Authorization "$backend_token";

        proxy_connect_timeout 60s;
        proxy_send_timeout 60s;
        proxy_read_timeout 60s;
    }
}

3. Активируйте конфигурацию и перезапустите nginx:

ln -s /etc/nginx/sites-available/max-proxy /etc/nginx/sites-enabled/
nginx -t
systemctl restart nginx

Использование в коде

В вашем приложении нужно указать библиотеке использовать собственный базовый URL (адрес вашего прокси-сервера) и передавать логин/пароль через стандартный заголовок Authorization: Basic .... Библиотека maxbot позволяет это сделать:

use maxbot::{MaxClient, set_global_base_url};

// 1. Устанавливаем глобальный базовый URL (все клиенты будут использовать прокси)
set_global_base_url("https://max.my-russian-company.ru");

// 2. Создаём клиент и передаём логин:пароль в виде "логин:пароль".
let client = MaxClient::new("ivanov.i:my_secret_password1");

// 3. Все дальнейшие вызовы автоматически используют прокси.
let me = client.get_me().await?;

Важно: В этом режиме токен бота нигде в коде не фигурирует — он остаётся только на сервере nginx. Разработчики используют свои личные учётные данные.

Если вам нужно переопределить базовый URL только для конкретного клиента, используйте метод set_base_url:

let mut client = MaxClient::new("petrov.p:my_secret_password2");
client.set_base_url("https://max.my-russian-company.ru");

📚 Полная документация API

Все методы сгруппированы в impl MaxClient:

Все методы асинхронны, используют reqwest и автоматически соблюдают лимит 30 запросов в секунду (rate limiting). Длинные тексты разбиваются на фрагменты до 4000 символов с сохранением целостности слов и предложений.

🧪 Примеры

Полные примеры в папке examples/:

• me_demo.rs – информация о боте
• send_text_demo.rs – отправка текста
• send_long_text_demo.rs – разбиение длинного текста
• send_file_demo.rs – отправка изображения
• send_video_demo.rs – отправка видео
• send_audio_demo.rs – отправка аудио
• send_inline_keyboard_demo.rs – клавиатура
• callback_demo.rs – обработка нажатий кнопок
• forward_demo.rs – пересылка сообщения
• delete_messages_demo.rs – отправка и удаление
• ask_phone_demo.rs – запрос контакта
• ask_location_demo.rs – запрос геолокации

Запуск примера:

export MAXBOT_TOKEN="ваш_токен"
export CHAT_ID="123456789"
cargo run --example send_text_demo

✅ Что уже реализовано

• Базовая HTTP-обёртка с rate limiting (30 RPS)
• Получение информации о боте (/me)
• Управление чатами: получение, обновление, удаление, выход
• Управление участниками и администраторами
• Отправка сообщений (текст, markdown, html, reply)
• Разбиение длинного текста на фрагменты (сохранение целостности слов/предложений)
• Отправка файлов (изображения, видео, аудио, документы)
• Пересылка сообщений
• Удаление сообщений (одиночное и массовое)
• Закрепление/открепление сообщений
• Действия бота (typing, upload_photo и т.д.)
• Long polling (/updates)
• Ответ на callback-запросы (inline-кнопки) – замена сообщения и уведомления
• Webhook-подписки (создание, удаление, список)
• Получение списка сообщений из чата (/messages с пагинацией)
• Редактирование сообщений (текст, клавиатура) – через answer_callback_query
• Удобные Builder'ы для параметров сообщений и клавиатур
• Поддержка всех типов вложений: стикеры, контакты, геолокация, share

🔮 Планы на будущее

• Получение информации о видео (/videos/{token})
• Автоматическая конвертация ответов в более удобные структуры
• Улучшенная обработка ошибок с конкретными типами
• Поддержка прокси
• Логирование через log или tracing
• Генерация документации с примерами на docs.rs

📄 Лицензия

Проект распространяется под лицензией MIT.

🤝 Вклад

Принимаются pull request'ы. Для крупных изменений сначала откройте issue для обсуждения.

🌐 Полезные ссылки

• Документация API MAX
• Репозиторий библиотеки
• Crates.io