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.

Три основных сценария

Каталог или контентный сайт

  1. Подготовьте Application.
  2. Получите каталог, тарифы и цены.
  3. Подключите страницы и публикации, контентные блоки и меню.
  4. Добавьте вход только для функций, которым нужен клиент: избранное, история, заказ или подписка.

Обычная покупка

  1. Покажите товары и доступные варианты доставки и оплаты.
  2. Рассчитайте корзину через POST /api/counterparty/orders/precalculate.
  3. Авторизуйте клиента.
  4. Создайте заказ через POST /api/counterparty/orders.
  5. Считайте оплату подтверждённой только по состоянию, которое вернул backend Gigma, а не по возврату пользователя с платёжной страницы.

Подробный поток находится в разделе «Заказы, оплаты и подписки».

Подписка и платный доступ

  1. Получите тарифы из subscription-catalog.
  2. Авторизуйте клиента.
  3. Создайте checkout подписки и перенаправьте клиента по payment_link.
  4. После оплаты повторно получите подписки клиента.
  5. Открывайте доступ только при status = "active" и неистёкшем current_period_end.
  6. Повторяйте эту проверку на своём backend перед защищённым действием.

Минимальный путь до первого рабочего запроса

  1. Получите ERP-доступ к нужному Project.
  2. Создайте или выберите Application и сохраните его App Token.
  3. Настройте каталог, склады, оплату и контент в платформенном контуре.
  4. Проверьте App Token запросом GET /api/counterparty/settings.
  5. Получите каталог или подписочные тарифы.
  6. Подключите один способ входа клиента.
  7. Реализуйте один сквозной сценарий: каталог → вход → заказ либо тариф → вход → checkout → проверка подписки.

Карта документации

ЗадачаРаздел
Создать и настроить контекст продуктаПодготовка приложения
Спрятать токены и проверять платный доступ на сервереИнтеграция с backend
Войти по коду или callback-звонкуВход клиента
Получить и изменить профильПрофиль клиента
Показать товары, цены и подписочные тарифыКаталог, тарифы и цены
Рассчитать корзину, создать заказ или подпискуЗаказы, оплаты и подписки
Получить управляемый контентКонтентные блоки, страницы и публикации, меню и навигация
Получить настройки и данные поискаНастройки и поиск
Показать клиенту системные событияУведомления клиента
Получить доставку, оплату, магазины и фильтрыДоставка, оплата и справочники

Правила, которые нельзя переносить на frontend

  • факт оплаты и право доступа подтверждает backend;
  • App Token и Counterparty Bearer решают разные задачи и не заменяют друг друга;
  • идентификаторы справочников получайте из API, а не фиксируйте по примеру;
  • неизвестный результат создания платежа не означает неуспех: сначала проверьте текущее состояние;
  • Counterparty Bearer, callback-сессии и платёжные данные нельзя писать в URL, аналитику или клиентские логи.

© 2026 Gigma