☰ Меню · Обзор
Loyaltyfy API
Подключите кассу, систему онлайн-записи, киоск или своё приложение к картам лояльности Loyaltyfy, QR-меню и заказам со столов.
Loyaltyfy ведёт программы лояльности и цифровые меню для ресторанов, кафе, магазинов и салонов. Гость хранит карту в Apple Wallet или Google Wallet, заведение видит каждый визит и каждый чек. Через API в этом участвуют системы, которыми заведение уже пользуется: касса начисляет кэшбэк за закрытый чек, киоск у входа ставит штамп за визит, система онлайн-записи награждает за состоявшийся визит, POS забирает заказы, которые гости отправляют из QR-меню.
Это обычный REST API поверх HTTPS. Запросы и ответы в JSON, суммы передаются целыми числами в минимальных единицах валюты (12500 означает 125.00), время в формате ISO 8601. У каждого заведения свои ключи, поэтому одна интеграция подходит для любого числа заведений: вы храните ключ для каждого заведения и передаёте его в каждом запросе.
С чего начать
Найти гостя по карте, телефону или штрихкоду, провести чек, списать кэшбэк, отменить чек при возврате, выпустить карты со своими номерами.
Синхронизировать цены и стоп-лист, принимать заказы со столов, вести лояльность на кассе кафе.
Превратить любое сканирование в участника и список доступных действий. Регистрировать гостей на планшете. Ставить штампы за визит без чека.
Награждать за состоявшиеся визиты, синхронизировать клиентов, посмотреть, как это делает встроенный коннектор Altegio.
Базовый URL
Все эндпоинты находятся по адресу https://loyaltyfy.io/api/v1. Пути в документации начинаются с /v1, то есть GET /v1/members означает GET https://loyaltyfy.io/api/v1/members.
Основные объекты
| Объект | Что это |
|---|---|
| member | Гость, участвующий в программе лояльности заведения, с одной картой в Wallet. Ищется по номеру карты, штрихкоду, телефону или id. |
| transaction | Один закрытый чек, переданный кассой. Начисляет кэшбэк или штампы, может списывать кэшбэк, может быть отменён. |
| visit | Отметка о визите без чека: от киоска, сканера или системы онлайн-записи. |
| menu, menu_item | QR-меню заведения: категории, блюда, модификаторы, цены, стоп-лист. |
| order | Корзина, которую гость отправил из QR-меню за столом. POS принимает заказ и ведёт его по статусам. |
| event | Произошедшее событие (проведён чек, создан заказ), которое мы доставляем на ваш адрес вебхука. |
Что дальше
Сделайте первый запрос по инструкции Быстрый старт. С тестовым ключом это займёт около пяти минут.