Онлайн-запись и CRM

Салоны, клиники, студии и другие бизнесы, работающие по записи: начисляйте награду, когда клиент действительно пришёл.

В системе записи важен момент, когда визит отмечен как состоявшийся, и сумма, которую заплатил клиент. Сопоставьте события с API так:

В системе записи	Запрос
Новый клиент с телефоном	`POST /v1/members` (если телефон уже известен, вернёт существующего участника)
Визит состоялся и оплачен	`POST /v1/transactions` с id записи в `external_id` и оплаченной суммой
Визит состоялся, данных об оплате нет	`POST /v1/visits` с id записи в `external_id` (программы со штампами и визитами)
Оплата отменена или возвращена	`POST /v1/transactions/{external_id}/void`
Клиент хочет оплатить кэшбэком	Прочитайте `cashback.balance`, затем отправьте чек с `redeem_amount`

В external_id передавайте id записи, а не id клиента: тогда запись, дважды отмеченная как состоявшаяся, принесёт начисление только один раз.

Altegio

Заведениям на Altegio код писать не нужно: достаточно установить приложение Loyaltyfy из маркетплейса Altegio и подключить филиалы. То, как работает этот коннектор, хороший образец для вашей собственной интеграции:

Он слушает вебхуки записей Altegio. Запись с подтверждённым приходом проводится как чек, id записи служит ключом идемпотентности.
Если у клиента ещё нет карты Loyaltyfy, визит ждёт. Когда клиент добавит карту (с тем же телефоном), ожидающие визиты проводятся, и ничего не теряется.
Каждые 15 минут коннектор дополнительно опрашивает свежие записи, потому что вебхуки могут теряться. Дубликаты отсекаются по id записи.
Когда кассир списывает кэшбэк в Loyaltyfy, сумма может записаться в открытый визит Altegio как оплата бонусами, если в сети настроен тип карты лояльности.

Другие системы

Если ваша система записи или CRM умеет отправлять вебхуки, проще всего сделать небольшой сервис, который принимает их и вызывает эндпоинты из таблицы выше. Если не умеет, раз в несколько минут запрашивайте через её API состоявшиеся визиты и отправляйте их вместе с id. Повторы ничего не испортят. Напишите на api@loyaltyfy.io, если хотите, чтобы мы сделали готовый коннектор для вашей платформы.