Перейти к основному содержимому

Введение в SDK

@maxscrm/sdk — официальный JavaScript/TypeScript SDK для создания мини-приложений для маркетплейса MAXSCRM.

Что даёт SDK​

  • Авторизация — обмен initData из MAX на JWT (без управления токенами);
  • Данные CRM — контакты, сделки, сообщения, аналитика;
  • Контекст — текущий пользователь, организация, активная сущность;
  • Хранилище — изолированное key-value хранилище приложения;
  • UI-мост — postMessage-мост для iframe-хостинга и событий платформы;
  • Типы — полная TypeScript-типизация.

Как устроен маркетплейс​

Сторонний разработчик            MAXSCRM
┌──────────────────────┐        ┌──────────────────────────────┐
│ Мини-приложение      │        │ Платформа                    │
│ (React/vanilla)      │        │  • Песочница (iframe)        │
│  + @maxscrm/sdk      │ ─────► │  • API (JWT, tenant)         │
│  + manifest.json     │        │  • Webhooks (HTTPS)          │
└──────────────────────┘        │  • Маркетплейс (ревью)       │
                                └──────────────────────────────┘

Жизненный цикл приложения​

  1. Разработчик создаёт приложение по шаблону maxscrm-mini-app-template.
  2. Регистрирует в маркетплейсе (Developer Portal) — статус draft.
  3. Отправляет на ревью (submit) — автовалидация манифеста, статус pending.
  4. Администратор платформы одобряет (approve) → approved.
  5. Публикация (publish) → приложение доступно в маркетплейсе.

Требования​

  • Node.js 18+;
  • манифест проходит автовалидацию (обязательные поля, HTTPS-URL, допустимые permission scopes и UI-слоты);
  • прямой доступ к API платформы запрещён — только через SDK.

Дальше​