Документация по API SubGram
Всё необходимое для интеграции ваших сервисов с нашей платформой.
Начало работы
API SubGram предоставляет программный доступ к функциям нашей платформы. Вы можете управлять ботами, заказами на рекламу, получать статистику и многое другое.
Все запросы к API следует отправлять на базовый URL:
Аутентификация
Для взаимодействия с API требуется ключ аутентификации. Каждый запрос должен содержать HTTP-заголовок Auth с вашим ключом.
Существует три основных типа ключей, каждый для своих задач:
-
Ключ-доступа (Secret Key): 🔐 Ваш главный и секретный ключ для выполнения управляющих действий: создание и обновление заказов (
/orders), добавление и настройка ботов (/bots).
Как получить: в нашем официальном боте @subgram_officialbot перейдите вПрофиль → Ключ-доступа (Secret Key). Никогда и никому не передавайте этот ключ! -
Токен статистики (API Token): 📈 Этот токен предназначен только для получения данных, таких как баланс (
/get-balance) и статистика (/statistic).
Как получить: в боте @subgram_officialbot перейдите вПрофиль → Скопировать api token. -
Ключ бота (API Key): 🤖 Генерируется для каждого добавленного бота. Используется для запросов от имени конкретного бота: получение спонсоров (
/get-sponsors) и проверка подписок (/get-user-subscriptions).
Пример заголовка
Auth: ВАШ_СЕКРЕТНЫЙ_КЛЮЧ_ДОСТУПА
Структура ответов
Все ответы от API приходят в формате JSON. Успешные ответы и ошибки имеют стандартизированную структуру для предсказуемой обработки.
Пример успешного ответа (HTTP 200 OK)
{
"status": "ok",
"code": 200,
"message": "Операция прошла успешно",
"result": { ... }
}
result или response в зависимости от эндпоинта. Всегда проверяйте документацию для конкретного метода.
Пример ответа с ошибкой (HTTP 4xx/5xx)
{
"status": "error",
"code": 401,
"message": "Невалидный API токен"
}