К содержанию
MGRAMБаза знаний

Partner API

Для фабрик ботов: регистрация ботов клиентов и управление ими.

Обновлено 16 октября 20262 мин чтения3 просмотра

Partner API нужен фабрикам ботов и сервисам, которые создают ботов для клиентов. Он позволяет подключать ботов к MGRAM и управлять ими с сервера — без ручных действий в @mgram_robot.

Как получить доступ

  1. Ваш Partner ID — это ваш Telegram ID.
  2. Отправьте его в «Поддержку» в @mgram_robot и опишите, для чего нужен доступ.
  3. Вы получите Partner API key. Он показывается один раз — сохраните его в надёжном месте.

Запросы отправляются на https://api.mgram.biz с заголовком Authorization: Bearer ВАШ_PARTNER_API_KEY.

Возможности

МетодЧто делает
POST /register/botРегистрирует бота по токену. Владельцем по умолчанию становитесь вы, можно указать аккаунт клиента
GET /register/botsСписок ваших ботов со статусами модерации, включая ботов на аккаунтах клиентов
POST /register/bots/settingsВключает или выключает рассылки и Показы сразу у группы ботов — до 500 за запрос
POST /register/bot/reply-adsВключает или выключает Показы у одного бота
POST /register/webhook/testОтправляет тестовое событие на ваш HTTPS-адрес

При регистрации бота в ответе приходит его Bot API key — он тоже показывается один раз. С ним можно работать со статистикой и заданиями этого бота, см. API статистики и управления ботом и API заданий.

Как проходит подключение

  1. Вы регистрируете бота через POST /register/bot.
  2. Бот проходит обычную модерацию MGRAM.
  3. Статус и, при отказе, причину видно в GET /register/bots — или получите решение модерации на webhook.

Правила

  • Боты регистрируются по тем же правилам, что и вручную: живая аудитория, честная категория, без накрутки.
  • Массовые операции атомарны: если хотя бы один бот не ваш, не изменится ни один.
  • Partner API key даёт доступ ко всем вашим ботам — храните его только на сервере.

Полное описание методов, ошибок и webhook — на api.mgram.biz.