☰ Мәзір · Шолу
Loyaltyfy API
Кассаны, жазылу жүйесін, киоскті немесе өз қосымшаңызды Loyaltyfy адалдық карталарына, QR-мәзірге және үстелден келетін тапсырыстарға қосыңыз.
Loyaltyfy мейрамханаларға, кафелерге, дүкендерге және салондарға адалдық бағдарламалары мен цифрлық мәзірді жүргізеді. Қонақ картасын Apple Wallet немесе Google Wallet ішінде сақтайды, ал мекеме әр келуді және әр чекті көреді. API мекеме қазір қолданып отырған жүйелерді осы процеске қосады: касса жабылған чек үшін кэшбэк есептейді, кіреберістегі киоск келуге штамп қояды, жазылу жүйесі өткен жазылым үшін сыйақы береді, POS қонақтар QR-мәзірден жіберген тапсырыстарды қабылдайды.
Бұл HTTPS арқылы жұмыс істейтін қарапайым REST API. Сұраулар мен жауаптар 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 | Болған оқиға (чек өтті, тапсырыс түсті). Сіздің вебхук эндпоинтіңізге жеткізіледі. |
Әрі қарай
Алғашқы шақыруды Жылдам бастау бөлімінде жасаңыз. Тест кілтімен шамамен бес минут алады.