Полная API-документация
Где найти справочник методов, примеры кода и описание ошибок.
Полная техническая документация MGRAM — на api.mgram.biz. База знаний объясняет сценарии, а справочник — каждый метод.
Что есть в документации
- Быстрый старт для ботов и для фабрик ботов: какой ключ нужен и с чего начать.
- Справочник всех методов с параметрами и ответами и поиском по пути или названию.
- Примеры кода: выберите метод и язык — получите готовый код и пример ответа.
- Ошибки: единый формат и что исправить для каждого HTTP-кода.
- Проверка webhook: отправьте тестовое событие на свой адрес прямо со страницы документации.
Общие правила API
- Обычные HTTPS-запросы с JSON — SDK не нужен.
- Базовый адрес —
https://api.mgram.biz. - Ключ передаётся в заголовке
Authorization: Bearer КЛЮЧ. - Webhook должен быть публичным HTTPS-адресом и отвечать 200 или 204. Подпись — HMAC-SHA256 от
timestamp.телов заголовкеX-MGRAM-Signature.
Какие бывают ключи
| Ключ | Для чего | Где взять |
|---|---|---|
| Bot API key | Задания, статистика и настройки одного бота | Карточка бота → «Настройки» → «API-ключ» |
| Partner API key | Регистрация и управление ботами фабрики | Через «Поддержку», по вашему Telegram ID |
Обзор по сценариям
- API заданий — монетизация бота заданиями.
- API статистики и управления ботом — данные и настройки бота.
- Partner API — для фабрик ботов.
Не нашли метод или нужна помощь с интеграцией — напишите в «Поддержку» или в чат @mgram_chat.