Что такое 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 | конкретное Application | Token: <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 |