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

Быстрый старт

1. Установите SDK​

npm install @maxscrm/sdk

2. Создайте приложение​

import { createClient } from '@maxscrm/sdk';

const sdk = createClient({
  apiBaseUrl: 'https://api.maxscrm.com',
  appId: 'com.example.hello-contact',
  sandbox: true,
});

// Авторизация через initData из MAX
await sdk.init(window.WebApp.initData);

// Контекст: пользователь, организация, активная сущность
const ctx = await sdk.getContext();

if (ctx.entity.type === 'contact' && ctx.entity.id) {
  const contact = await sdk.contacts.get(ctx.entity.id);
  console.log(`Привет, ${contact.name}!`);
}

3. Манифест​

{
  "id": "com.example.hello-contact",
  "name": "Hello Contact",
  "version": "1.0.0",
  "apiVersion": "1.0",
  "description": "Показывает текущий контакт в сайдбаре CRM",
  "author": "Your Company",
  "homepage": "https://example.com",
  "iconUrl": "https://example.com/icon.png",
  "permissions": ["crm.contacts.read"],
  "ui": {
    "slots": ["crm.contact.sidebar"],
    "entrypointUrl": "https://your-app.example.com/app.js"
  },
  "pricing": { "model": "free" }
}
important

entrypointUrl должен быть HTTPS. Поле id — в формате доменного имени (com.example.app).

4. Запуск в песочнице​

Отправьте манифест в Developer Portal → песочница откроет ваше приложение в iframe с полным SDK-мостом.

Шаблон​

Готовый шаблон с примером виджета: maxscrm-mini-app-template