☰ Meniu · Prezentare generală
API Loyaltyfy
Conectează o casă de marcat, un sistem de programări, un chioșc sau propria aplicație la cardurile de fidelitate, meniurile QR și comenzile de la masă Loyaltyfy.
Loyaltyfy gestionează programe de fidelitate și meniuri digitale pentru restaurante, cafenele, magazine și saloane. Oaspeții își păstrează cardul în Apple Wallet sau Google Wallet, iar localul vede fiecare vizită și fiecare bon. Prin API, sistemele pe care localul le folosește deja devin parte din program: casa acordă cashback la închiderea bonului, chioșcul de la intrare pune o ștampilă pentru vizită, sistemul de programări recompensează o programare onorată, iar POS-ul preia comenzile trimise de oaspeți din meniul QR.
Este un API REST simplu, prin HTTPS. Cererile și răspunsurile sunt în JSON, sumele sunt numere întregi în subunități (12500 înseamnă 125,00), iar datele și orele sunt în format ISO 8601. Fiecare local are cheile lui, așa că o singură integrare funcționează pentru oricâte localuri: păstrezi câte o cheie pentru fiecare local și o trimiți la fiecare apel.
Alege de unde începi
Găsește oaspetele după card, telefon sau cod de bare, aplică un bon, folosește cashback-ul, anulează la retur, emite carduri cu numerele tale.
Sincronizează prețurile și stop-listul, primește comenzi de la masă, rulează programul de fidelitate la casa cafenelei.
Transformă orice scanare într-un membru și o listă de acțiuni permise. Înscrie oaspeți de pe o tabletă. Pune ștampile pentru vizite fără bon.
Recompensează programările onorate, sincronizează clienții, vezi cum lucrează conectorul Altegio integrat.
URL de bază
Toate endpointurile se află sub https://loyaltyfy.io/api/v1. Căile din această documentație încep cu /v1, deci GET /v1/members înseamnă GET https://loyaltyfy.io/api/v1/members.
Obiectele principale
| Obiect | Ce este |
|---|---|
| member | Un oaspete înscris în programul de fidelitate al localului, cu un card în wallet. Îl găsești după numărul cardului, codul de bare, telefon sau id. |
| transaction | Un bon închis, trimis de casă. Aduce cashback sau ștampile, poate folosi cashback, poate fi anulat. |
| visit | O vizită fără bon, înregistrată de un chioșc, un scaner sau un sistem de programări. |
| menu, menu_item | Meniul QR al localului: categorii, preparate, modificatori, prețuri, stop-list. |
| order | Un coș trimis de oaspete din meniul QR, de la masă. POS-ul îl acceptă și îl trece prin statusuri. |
| event | Ceva ce s-a întâmplat (un bon aplicat, o comandă plasată), livrat la endpointul tău de webhook. |
Mai departe
Fă primul apel urmând Primii pași. Cu o cheie de test durează cam cinci minute.