База знаний/Интеграции и оборудование

Как получить токен и отправить запрос к API FitBase?

Токен создаётся в Настройки → Интеграции → плитка «FitBase API» (страница «FitBase API») кнопкой «Добавить токен» с выбором филиалов, запросы уходят на https://api.fitbase.io/api/v2/ с заголовками Authorization и domain. API открытый и работает по схеме CRUD: создание, чтение, изменение, удаление.

Токен

  1. Откройте Настройки → Интеграции → «FitBase API» и нажмите «Добавить токен». В окне поля «Токен API», «Филиалы», «Комментарий», кнопка «Сохранить».
Страница «FitBase API»: «Добавить токен», список токенов, «Документация»
Страница «FitBase API»: «Добавить токен», список токенов, «Документация»
  1. Выберите филиалы из списка. Токен будет работать только с ними, список меняется там же через редактирование токена.
Окно «Добавить токен»: «Токен API», «Филиалы» (шаг 2), «Комментарий», «Сохранить»
Окно «Добавить токен»: «Токен API», «Филиалы» (шаг 2), «Комментарий», «Сохранить»

Токен даёт право не только читать, но и создавать и удалять клиентов и заявки.

Запрос

В заголовках укажите Authorization: Bearer токен и domain: поддомен (то, что стоит в адресе перед .fitbase.io, например demo для https://demo.fitbase.io). Без заголовка domain сервер отвечает ошибкой 500, а не 401, по ней причину не угадать. Часть методов, например /v2/advertising-source, ждёт поддомен в заголовке club: какой заголовок нужен, написано у метода в Swagger.

`` curl --location 'https://api.fitbase.io/api/v2/schedule-registration' \ --header 'domain: demo' \ --header 'Authorization: Bearer токен' ``

ЗапросЧто делает
GETСписок, постраничный: параметры page и page_size (не больше 100), в ответе total_count
GET /{id}Один объект
POSTСоздать, данные в JSON
PATCH /{id}Изменить, данные в JSON
DELETE /{id}Удалить

Продажи лежат в till-order-steps: amount это живые деньги, priceDeposit списано с депозита, у бартера amount равен 0; фильтр по датам идёт по дате оплаты, день включительно по времени клуба. Тренер у проданной услуги виден только через client-service по item_id, абонементы к тренеру не привязаны.

Swagger

Все методы и поля описаны в Swagger: https://api.fitbase.io/docs_v2 (ссылка «Документация» на странице токенов). Запрос можно отправить прямо там: добавьте токен, в нужном методе нажмите «Try it out», укажите параметры и нажмите «Execute». В блоке Request виден сформированный запрос, в блоке Response ответ сервера.

Сущности

СущностьЧто это
ClientКлиенты клуба. При создании получают ID, к которому привязаны абонементы, услуги и посещения
ClientContractАбонементы клиентов
ClientServiceУслуги клиентов: шаблон, даты действия, число использований, данные оплаты
ClientProductТовары клиентов: товар, количество, цена, данные оплаты
ContactКонтакты клиента, каждый телефон или e-mail отдельной записью
LeadЗаявки: контакты, менеджер, этап воронки, рекламный источник
NoteЗаметки о клиентах
ScheduleЗанятие в расписании; registrations_count в нём это набор счётчиков: записано, пришло и т. д.
ScheduleRegistrationЗапись клиента на занятие
TaskЗадачи: клиент или заявка, статус, описание, тип, создатель, ответственный
UserВсе сотрудники: менеджеры, администраторы, тренеры, фильтр по ролям
PlaceЗалы, в которых проходят занятия

ИИ-агент или чат-бот через API

Бот, который принимает заявки из соцсетей, может создать Lead или Client, поставить менеджеру Task и показать клиенту расписание из Schedule. Записать клиента на занятие через API нельзя: ScheduleRegistration только читается и удаляется. Отправки сообщений клиентам (SMS, мессенджеры, чат приложения) в API нет.