Что такое Gigma

Gigma — платформа с готовыми API для сайтов, приложений и внутренних процессов бизнеса.

Подключайте готовые функции: вход пользователей, каталог, заказы, оплаты, подписки, контент, склад, CRM и работу команды. Интерфейс остаётся вашим — Gigma хранит данные и выполняет операции по API.

Документация рассчитана на разработчиков и команды, которые создают собственный продукт и готовы работать с кодом.

Что можно подключить

Сайт, приложение или сервис

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

Управление бизнесом из кода

Управляйте продуктом через профильные разделы: бизнесы и реквизиты, приложения, каталог, склад, CRM и продажи, команду и доступ и CMS.

ИИ-агент

Подключите агента к разрешённым операциям проекта. Агент получает отдельный Agent Token и только те права, которые подтвердил владелец или администратор. Порядок подключения описан в получении доступа агентом.

Как выбрать документацию

Выберите направление по тому, кто отправляет запрос и какую задачу решает.

НаправлениеКто используетГде смотреть
Клиентские методыклиентская часть продукта или её backendинтернет-магазин и приложения, вход клиента, подписки, CMS, профиль клиента
Управление бизнесомсотрудник, внутренний сервис или ИИ-агентбизнесы, приложения, каталог, склад, CRM, команда, контент

Данные проекта общие, а ключи доступа — разные:

  • App Token выбирает Application, но не подтверждает личность клиента;
  • Counterparty Bearer представляет конкретного клиента;
  • User Bearer представляет сотрудника или техническую учётную запись;
  • Agent Token представляет отдельного агента и ограничен выданными правами.

User Bearer и Agent Token нельзя передавать в клиентскую часть продукта. Точный набор заголовков указан у каждого метода, а общие правила хранения ключей собраны в правилах API.

С чего начать

Создаёте новое пространство Gigma — начните с раздела «Создание проекта и регистрация первого владельца». В нём один последовательный сценарий: подготовить menu_id, создать проект вместе с первым владельцем, войти по одноразовому паролю и проверить User Bearer запросом GET /api/user.

После первого входа переходите сразу к профильному гайду:

ЗадачаСледующий раздел
Запустить сайт, приложение или сервисНастройка приложения
Добавить бизнес, товары, склад или контентБизнесы, каталог, склад или CMS
Подключить сотрудников или программного агентаКоманда и доступ или Агентский доступ

Здесь эти шаги не повторяются: страница объясняет модель платформы, а практические разделы содержат проверяемые запросы, ответы и восстановление после ошибок.

Как устроены данные

Контекст и участники

ОбъектЧто означает
Projectверхняя граница данных и доступа организации или владельца
Branchбизнес, юридическое лицо, филиал или операционное направление внутри проекта
Applicationконкретный сайт, приложение или сервис с собственными настройками и App Token
Userсотрудник или техническая учётная запись с ролью и правами внутри проекта
Agentотдельная учётная запись агента с собственным токеном и выданными правами
Counterpartyвнешний клиент или компания, которые взаимодействуют с продуктом

Операционные объекты

ОбъектЧто означает
Nomenclatureтовар, услуга или подписочный тариф
Warehouseместо хранения и источник доступных остатков
Inventoryколичество, цена и параметры позиции на конкретном складе
Reservationколичество товара, временно заблокированное под заказ или клиента
Orderоперация продажи и её текущее состояние
Taskвнутренняя работа сотрудника, связанная с заказом, клиентом или процессом

Все объекты относятся к своему Project. Идентификатор id помогает найти ресурс, но сам по себе не подтверждает право доступа к нему.

Ключи доступа

КлючКого или что представляетЗаголовок
App Tokenконкретное ApplicationToken: <application_token>
Counterparty Bearerвнешнего клиентаAuthorization: Bearer <counterparty_access_token>
User Bearerсотрудника или техническую учётную записьAuthorization: Bearer <user_access_token>
Agent Tokenотдельного агентаAuthorization: Bearer <agent_token>

App Token может быть виден пользователю в сетевых запросах. Поэтому его нельзя использовать как доказательство личности, оплаты или права на закрытую функцию.

User Bearer, Agent Token и Counterparty Bearer выглядят одинаково на уровне HTTP, но относятся к разным субъектам и не взаимозаменяются. Доступ каждого сотрудника и агента дополнительно ограничен проектом и выданными правами.

Для серверной интеграции от имени сотрудника создайте техническую учётную запись, а не используйте личный токен человека.

Кто за что отвечает

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

Куда перейти дальше

ЗадачаРаздел
Создать проект и зарегистрировать первого владельцаПервый запуск
Подготовить сайт, приложение или интернет-магазинИнтернет-магазин и приложения
Настроить бизнес и реквизитыБизнесы и реквизиты
Настроить Application и вебхукиПриложение и App Token
Вести товары и услугиКаталог
Управлять складами и остаткамиУправление складом
Работать с клиентами и заказамиCRM и продажи
Управлять сотрудниками и правамиКоманда и доступ
Подключить ИИ-агентаАгентский доступ
Продавать регулярный доступПодписки
Управлять страницами и контентомCMS для сайтов
Проверить правила токенов, ошибок и повторовПравила API
Найти допустимые значения справочниковСправочники и значения
Получить машиночитаемый контрактOpenAPI и Swagger UI