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

API заданий

Показывайте пользователям своего бота задания MGRAM и получайте доход за выполнение.

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

API заданий позволяет вашему боту самому показывать пользователям задания MGRAM — подписаться на канал, вступить в чат, запустить бота — и получать доход за каждое выполнение. Это та же монетизация, что и ОП в боте, но интерфейс и момент показа выбираете вы.

Что нужно

  • Бот, подключённый к MGRAM.
  • Bot API key — ключ бота: «Мои боты» → ваш бот → «Настройки» → «API-ключ». Ботам, подключённым без токена, ключ выдавался при подключении.
  • Сервер вашего бота, который умеет делать HTTPS-запросы с JSON.

Как это работает

  1. Получите задания. Когда пользователь пишет вашему боту, вызовите POST /tasks с его user_id. В ответе — список заданий: название, ссылка, текст кнопки и сумма, которую вы получите за выполнение.
  2. Покажите задания кнопками. Ссылка и текст кнопки уже в ответе. По умолчанию приходит 3 задания, можно запросить от 1 до 10.
  3. Узнайте о выполнении. Либо вызовите POST /tasks/check по кнопке «Проверить», либо подключите webhook — MGRAM сам пришлёт событие на ваш сервер, когда пользователь выполнит задание или отпишется.
  4. Пустите дальше. Когда в ответе skip: true, всё выполнено — продолжайте работу бота.

Пример запроса

POST https://api.mgram.biz/tasks с заголовком Authorization: Bearer ВАШ_BOT_API_KEY и телом {"user_id": 123456789}.

В ответе вы получите status, skip и массив tasks, где у каждого задания есть title, link, button_text и reward.

Сколько вы получаете

  • За подписку на канал или вступление в чат — 70% цены задания. Если пользователь отпишется в течение 24 часов, доход за эту подписку списывается.
  • За запуск бота — 70% цены, не списывается.
  • Ответ API показывает, сколько уже заработано и сколько ещё проверяется.

Webhook

POST /tasks/webhook с вашим url включает отправку событий на ваш сервер. Каждое событие подписано: проверяйте заголовок X-MGRAM-Signature — это HMAC-SHA256 от timestamp.тело_запроса с секретом из ответа. Отвечайте кодом 200 или 204. Пустой url выключает webhook.

Боты без токена

Боты, которые раньше были подключены без токена, работают только через API заданий:

  • засчитываются вступления по ссылкам из ответа API;
  • задания на запуск ботов им не выдаются;
  • засчитывается не больше 30 новых пользователей в минуту.

Чтобы открыть такому боту рассылки, Показы и ОП, добавьте его токен в карточке бота.

Правила

  • Показывайте задания только реальным пользователям, которые сейчас пользуются ботом.
  • Не подменяйте ссылки из ответа API — иначе выполнение не засчитается.
  • Действия ферм и накрученных аккаунтов не оплачиваются, а бот с признаками накрутки могут остановить.

Полный справочник с параметрами, ответами и примерами кода — на api.mgram.biz.