API для сайтов, приложений и сервисов
Этот раздел описывает API Gigma для сайтов, приложений и цифровых сервисов. Gigma хранит настройки приложения, клиентские профили, каталог, заказы, платежи, подписки и управляемый контент. Вы создаёте интерфейс продукта и определяете, какие возможности получает клиент.
Что можно собрать
- витрину товаров или услуг;
- оформление обычного заказа и онлайн-оплату;
- подписочный сервис с периодической оплатой;
- личный кабинет клиента;
- сайт или приложение с управляемыми страницами, меню и контентными блоками;
- закрытый сервис, где доступ открывается после подтверждённой покупки или активной подписки.
Как устроена модель
| Сущность | Простое объяснение |
|---|---|
Project | граница данных и доступа вашего бизнеса |
Application | конкретный сайт, приложение или сервис внутри проекта |
| App Token | выбирает Application и разрешает обращаться к API текущего сайта, приложения или сервиса |
Client / Counterparty | клиент, который входит, оформляет заказы и оплачивает подписки |
| Counterparty Bearer | подтверждает, от имени какого клиента выполняется запрос |
Application не создаёт интерфейс и не заводит отдельную базу клиентов. Оно связывает запросы с настройками нужного продукта: каталогом, складами, контентом, способами оплаты и подписочными тарифами.
Подробные правила заголовков и назначения токенов собраны в соглашениях об авторизации.
Выберите схему интеграции
Прямые запросы из сайта или приложения
Подходят для публичного каталога, страниц, меню, входа клиента и стандартного оформления заказа. Клиентское приложение передаёт App Token, а после входа — также Counterparty Bearer.
Не используйте эту схему для защиты собственных закрытых данных: решение о доступе нельзя оставлять только браузеру.
Через собственный backend или BFF
Используйте эту схему, когда покупка или подписка в Gigma должна открыть функции вашего сервиса. Ваш backend хранит Counterparty Bearer, создаёт локальную сессию и перед выдачей закрытых данных проверяет актуальное состояние заказа или подписки в Gigma.
Перейдите к интеграции с backend.
Три основных сценария
Каталог или контентный сайт
- Подготовьте
Application. - Получите каталог, тарифы и цены.
- Подключите страницы и публикации, контентные блоки и меню.
- Добавьте вход только для функций, которым нужен клиент: избранное, история, заказ или подписка.
Обычная покупка
- Покажите товары и доступные варианты доставки и оплаты.
- Рассчитайте корзину через
POST /api/counterparty/orders/precalculate. - Авторизуйте клиента.
- Создайте заказ через
POST /api/counterparty/orders. - Считайте оплату подтверждённой только по состоянию, которое вернул backend Gigma, а не по возврату пользователя с платёжной страницы.
Подробный поток находится в разделе «Заказы, оплаты и подписки».
Подписка и платный доступ
- Получите тарифы из
subscription-catalog. - Авторизуйте клиента.
- Создайте checkout подписки и перенаправьте клиента по
payment_link. - После оплаты повторно получите подписки клиента.
- Открывайте доступ только при
status = "active"и неистёкшемcurrent_period_end. - Повторяйте эту проверку на своём backend перед защищённым действием.
Минимальный путь до первого рабочего запроса
- Получите ERP-доступ к нужному
Project. - Создайте или выберите
Applicationи сохраните его App Token. - Настройте каталог, склады, оплату и контент в платформенном контуре.
- Проверьте App Token запросом
GET /api/counterparty/settings. - Получите каталог или подписочные тарифы.
- Подключите один способ входа клиента.
- Реализуйте один сквозной сценарий: каталог → вход → заказ либо тариф → вход → checkout → проверка подписки.
Карта документации
| Задача | Раздел |
|---|---|
| Создать и настроить контекст продукта | Подготовка приложения |
| Спрятать токены и проверять платный доступ на сервере | Интеграция с backend |
| Войти по коду или callback-звонку | Вход клиента |
| Получить и изменить профиль | Профиль клиента |
| Показать товары, цены и подписочные тарифы | Каталог, тарифы и цены |
| Рассчитать корзину, создать заказ или подписку | Заказы, оплаты и подписки |
| Получить управляемый контент | Контентные блоки, страницы и публикации, меню и навигация |
| Получить настройки и данные поиска | Настройки и поиск |
| Показать клиенту системные события | Уведомления клиента |
| Получить доставку, оплату, магазины и фильтры | Доставка, оплата и справочники |
Правила, которые нельзя переносить на frontend
- факт оплаты и право доступа подтверждает backend;
- App Token и Counterparty Bearer решают разные задачи и не заменяют друг друга;
- идентификаторы справочников получайте из API, а не фиксируйте по примеру;
- неизвестный результат создания платежа не означает неуспех: сначала проверьте текущее состояние;
- Counterparty Bearer, callback-сессии и платёжные данные нельзя писать в URL, аналитику или клиентские логи.