☰ Меню · Огляд
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 | Гість, зареєстрований у програмі лояльності закладу, з однією карткою в гаманці. Його можна знайти за номером картки, штрихкодом, телефоном або id. |
| transaction | Один закритий чек, надісланий касою. Нараховує кешбек або штампи, може списувати кешбек, його можна скасувати. |
| visit | Відмітка про візит без чека: з кіоску, сканера або системи запису. |
| menu, menu_item | QR-меню закладу: категорії, страви, модифікатори, ціни, стоп-лист. |
| order | Кошик, який гість надіслав із QR-меню за столом. POS приймає його й змінює статуси. |
| event | Подія (проведено чек, створено замовлення), яку ми доставляємо на ваш ендпоінт вебхуків. |
Що далі
Зробіть перший запит за інструкцією у Швидкому старті. З тестовим ключем це займе близько п’яти хвилин.