«Вираж» объединяет управление спортивным клубом, школой и мероприятиями в одном ядре: единый профиль человека работает сразу в программе лояльности, ДЮСШ и на массовых мероприятиях. Клуб подключает только нужные продукты и добавляет новые по мере роста без миграций и без потери накопленных данных.

Документация написана для команды разработки клуба или партнёра, который подключает к «Виражу» свой сайт, приложение или CRM. Слева находится навигация по модулям. Для каждого метода описаны назначение и параметры, приведён рабочий пример запроса и разобраны поля ответа. Пример можно скопировать и сразу проверить в песочнице.

Продукты «Виража»

Модули разных продуктов используют общие сущности. Например, user_id из «Пользователей» подходит и для «Лояльности», и для ДЮСШ. Синхронизировать данные между продуктами вручную не нужно, потому что все они работают с одним ядром.

Базовый адрес API

Все запросы отправляются на https://api.virazh.io/v1. Тела запросов и ответов передаются в JSON, коды состояния стандартные для HTTP, списки возвращаются постранично через курсор.

https://api.virazh.io/v1

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

• Начало работы: базовые понятия и аутентификация. Этот раздел стоит прочитать один раз перед первым запросом.
• Основные модули: по одной статье на ресурс. В начале статьи идёт обзорная таблица методов, дальше для каждого метода параметры, пример запроса и разбор полей ответа.
• Интеграции: вебхуки для уведомлений в реальном времени и справочник по ошибкам.