Девять GET-операций · факты сверены 16.10.2026

Объекты REST API и их связи

Найдите организацию текущего ключа, затем своего бота и связанные с ним списки. Бизнес-данные не меняются; время использования ключа и журнал могут обновляться.

Читать карту ↓Уже есть аккаунт? Проверить ключ →

Эта карта нужна разработчику. Для обычного запуска без своего кода начните с первого запуска AppsMax.

КАРТА ДОСТУПАОБЛАСТЬ ОДНОГО КЛЮЧА

01Организациятекущая, не все клиенты

02Ботid из доступного списка

03Подключение

04Мини-приложения

05Сценарии · меню

Связи объектов в API, не экран кабинета и не пример реальных данных.

У ключа API есть одна организационная область. Начните с GET /me, найдите доступного бота через GET /bots, затем используйте его id в связанных запросах. Так вы построите карту объектов без редактирования ботов и связанных объектов и без перебора чужих идентификаторов. Время последнего использования ключа и журнал запросов при этом могут обновляться.

01 · Контекст

Проверьте ключ, затем организацию

GET /ping подтверждает приём действующего ключа, GET /me возвращает права scopes, лимит запросов и организационный контекст. Эти два метода не требуют отдельного права чтения. GET /organizations с правом organizations:read возвращает коллекцию из текущей организации ключа, а не список всех клиентов AppsMax. Для дальнейших связей сохраните её id без токена и без личных контактных полей.

КЛЮЧ→ТЕКУЩАЯ ОРГАНИЗАЦИЯ→ДОСТУПНЫЙ БОТ

02 · Бот

Возьмите bot_id из доступного списка

GET /bots и GET /bots/{bot} требуют bots:read. Список ограничен текущей организацией; параметры driver и status помогают сузить его. По умолчанию возвращается 50 записей на страницу, per_page допускает 1–100. В ответе берите числовое id, не public_id, название или username. Нужного бота нет — проверьте выбранную организацию, фильтр и доступ, не перебирайте соседние числа.

# После безопасного ввода адреса и ключа по инструкции первого запроса:
printf 'header = "Authorization: Bearer %s"\n' "$APPSMAX_API_TOKEN" | \
  curl --fail-with-body --config - -H 'Accept: application/json' \
  "$APPSMAX_API_BASE/bots?page=1&per_page=50"

Базовый адрес оканчивается на /api/v1 и берётся из кабинета своего контура. Как безопасно ввести адрес и ключ. Первая страница может быть не последней: проверяйте links/meta.

03 · Подключение

Читайте сведения конкретного бота

GET /bots/{bot}/connections требует connections:read. Он возвращает описательную запись подключения выбранного бота: bot_id, тип канала driver, статус, допустимый публичный идентификатор и ограниченный профиль. Токен бота и закрытый payload не выдаются. Этот адрес не является перечнем всех готовых интеграций организации; для такого выбора используйте раздел интеграций.

Если бот не принадлежит организации ключа, ответ 404. Не используйте этот ответ для выяснения существования чужого ID.

04 · Ветви

От bot_id переходите к трём спискам

МИНИ-ПРИЛОЖЕНИЯGET /miniapps

miniapps:read; фильтры bot_id, status; по умолчанию 50, максимум 100 на страницу. Ответ перечисляет объектные поля, а не подтверждает готовый экран или публикацию.

СЦЕНАРИИGET /funnels

funnels:read; фильтры bot_id, active; по умолчанию 50, максимум 100. Признак активности нужно сверять с фактическим запуском.

ИНТЕРАКТИВНОЕ МЕНЮGET /interactive-menu

interactive_menu:read; фильтры bot_id, active; по умолчанию 100, максимум 200. Элемент меню — отдельная запись, не всё дерево действий клиента.

Эти три списка могут быть пустыми из-за фактического состава проекта или ограничения доступа. Не делайте из пустого ответа вывод, что функция включена или выключена для всех клиентов. Эта карта показывает объекты API; реальные действия и доступность мини-приложения проверяйте в своём кабинете перед использованием.

05 · Права

Выдайте только права нужных ветвей

Контекст: /ping и /me — без отдельного scope.
Основа: organizations:read, bots:read.
По задаче: connections:read, miniapps:read, funnels:read или interactive_menu:read — только для используемых списков.

Все девять операций этой карты — GET. Ключу обзорного скрипта не нужны права записи, запуска кампаний или изменения заявок. Отсутствующее право даёт 403; дополнительный тарифный или организационный gate проверяйте по фактическому ответу и текущим условиям, а не выводите из одного названия scope.

06 · Проверка

Сохраните карту без секретов

Запишите только нужные ID и отношения: organization.id → bot.id → connection/miniapp/funnel/menu. Для списков проходите страницы, сохраняя фильтры. Если получили 401, проверьте ключ; 403 — конкретный scope и доступ; 404 — выбранный бот в области организации; 422 — формат параметра; 429 — лимит запросов. Для разбора используйте время, метод и X-Request-Id, не публикуя ключ и полный ответ с данными организации.

Дальше берите проверенный bot_id для заявок или подписчиков. OpenAPI и технический справочник содержат точные поля для самостоятельной разработки. Если нужна готовая связка, сначала посмотрите обзор кабинета.