Инструкция API FitBase

В данной статье рассказываем зачем нужно API и как с ним работать.

Fitbase API v2 - открытое апи для прямой работы с сущностями системы в стиле CRUD, который использует четыре базовые функции при работе с базами данных: создание (англ. create), чтение (read), модификация (update), удаление (delete).

К примеру, с помощью API можно выгрузить список всех клиентов или создать/изменить клиента, получить проданные абонементы/услуги/товары используя фильтры или вывести расписание на своем ресурсе.

С какими объектами API позволяет работать

  • Client - Клиенты клубов.

Базовая сущностью в системе. При создании клиента ему присваивается ID, на который записываются абонементы, услуги, посещения и т.д.

  • ClientContract - Абонементы клиентов.

Формируется при продаже клиенту. Содержит в себе шаблон, даты действия, кол-во использований, данные по оплате.

  • ClientService - Услуги клиентов. 

Формируется при продаже клиенту. Содержит в себе шаблон, даты действия, кол-во использований, данные по оплате.

  • ClientProduct - Товары клиентов.

Формируется при продаже клиенту. Содержит в себе шаблон, даты действия, кол-во использований, данные по оплате.

  • Contact - Контакты клиентов.

Каждый контакт клиента, например номер телефона или почты, является отдельной сущностью Contact.

  • Lead - Заявки.

Содержит в себе контакты, менеджера, этап воронки, рекламный источник.

  • Note - Заметки о клиентах.

  • Schedule - Расписание.

Отражение занятия из расписания. При записи клиента на персональное занятие или при создании группового занятия формируется сущность Schedule.

  • ScheduleRegistration - Записи клиентов на занятия.

Каждая сущность является записью клиента Client на занятие Schedule

  • Task - Задачи.

Содержит в себе клиента/заявку, текущий статус, описание, тип, создателя, ответственного за выполнение.

  • User - Сотрудники.

Тут все, менеджеры, администраторы и тренера. Можно фильтровать по ролям.

  • Place - Залы.

Сущность, отражающая в каком зале проходят тренировки из расписания.


Как работать с API

Для работы с открытым API v2 FitBase необходимо:

  • Сначала создаем рабочий токен в разделе Настройки -> Интеграции -> ФитБейс API

  • На открытой странице Добавить токен -> Выбираем доступные филиалы из списка. Токен будет имеет доступ только в указанные клубы системы.


Если вам необходимо добавить или убрать клуб из доступа к API, то это можно сделать это в настройках токена в  разделе Настройки -> Интеграции -> ФитБейс API -> Редактировать нужный токен.

  • При отправке запроса указать в Headers:

Сlub: %name% (название клуба - домен третьего уровня в адресе вашего клуба)

Authorization: Bearer %token%

Пример curl запроса:
 curl --location 'https://club_name.fitbase.io/api/v2/schedule-registration' \ --header 'Club: club_name' \ --header 'Authorization: Bearer %token%'  


Как строится запрос API

Виды запросов в Fitbase API v2:

  • get - забрать список

пагинация, используйте page

  • get /{id} - забрать одно

где id - идентификатор объекта

  • post - создать

данные передаем в формате json

  • patch /{id} - изменить

данные передаем в формате json

  • delete /{id} - удалить

Описание методов:
Все методы представлены в нашем Swagger

В документации указаны все доступные API v2 методы и перечислены все поля сущностей.

Swagger предоставляет возможность отправки запросов прямо из веб-интерфейса.

Для этого необходимо:

  • Добавить токен авторизации созданный в CRM

  • Нажать «Try it out» в выбранном методе

  • Указать параметры запроса и нажать на кнопку «Execute»

  • В Response увидите формат запроса, а в Request - формат ответа


Работает на