API Loyaltify pozwala twojemu programiście połączyć Loyaltify z twoimi systemami, takimi jak kasa, narzędzie do rezerwacji lub strona internetowa. Na przykład kasa może automatycznie dodawać punkty po każdej sprzedaży, więc twój zespół nie musi skanować karty.
Ten przewodnik jest dla ciebie i twojego programisty: gdzie znaleźć klucz API, gdzie jest dokumentacja i co warto wiedzieć, zanim zaczniecie budować integrację.
💡 Warto wiedzieć: ta funkcja jest częścią planu Advanced. Przestaje działać po przejściu na niższy plan.
Znajdź swój klucz API
W Loyaltify kliknij swoją nazwę w prawym górnym rogu.
Przejdź do Twój profil i skopiuj klucz API.
Nie widzisz klucza API na swoim koncie Advanced? Napisz do zespołu wsparcia przez czat na żywo, a włączymy go dla ciebie.
⚠️ Traktuj klucz API jak hasło. Udostępniaj go tylko programiście i nigdy nie umieszczaj go w kodzie strony internetowej ani w linku.
Przeczytaj dokumentację
Pełna dokumentacja API znajduje się pod adresem api.loyaltify.io/api-docs. Kilka rzeczy, które twój programista powinien wiedzieć:
Wysyłaj klucz API w nagłówku
X-API-Keyprzy każdym żądaniu.Używaj adresu produkcyjnego,
api.loyaltify.io.Otwarcie endpointu w przeglądarce pokazuje „Unauthorized”. To normalne, bo przeglądarka nie wysyła twojego klucza.
Co możesz zrobić przez API
Rejestrować klientów przez jeden z twoich formularzy rejestracyjnych, na przykład z własnej strony internetowej lub aplikacji. Odpowiedź zawiera linki do karty klienta w Apple Wallet i Google Wallet.
Wyszukiwać klientów i ich transakcje, aktualizować ich dane lub ich usuwać.
Dodawać pieczątki, punkty lub środki albo realizować nagrody za pomocą żądania skanowania, tak jak robi to twój zespół w aplikacji Store. To, co wysyłasz, zależy od typu karty.
Warto wiedzieć
Kod QR na każdej karcie ma zawsze ten sam format:
lytf-, ID twojego sklepu, a następnie ID klienta. Kasa może go odczytać, aby znaleźć właściwego klienta.Każdy klient ma dwa identyfikatory: krótkie ID klienta (to z karty i z webhooków) oraz wewnętrzny numer używany w niektórych żądaniach API. Dokumentacja pokazuje, jak znaleźć jeden na podstawie drugiego.
Potrzebujesz ID swojego sklepu? Napisz do zespołu wsparcia przez czat na żywo.
Kilka lokalizacji lub kas może korzystać z tego samego klucza API.
Chcesz wiedzieć, kiedy coś się dzieje? Skorzystaj z funkcji Webhooks, aby otrzymywać wiadomość za każdym razem, gdy klient dołącza do programu lub coś zdobywa.
💡 Chcesz, żebyśmy zbudowali to za ciebie? Tworzymy też integracje na zamówienie, wyceniane osobno. Napisz do nas przez czat na żywo, podając system, z którego korzystasz, i to, co ma się dziać.
Potrzebujesz pomocy?
Chętnie pomożemy!
Jeśli masz pytania dotyczące API, napisz do nas przez czat na żywo w Loyaltify lub użyj przycisku czatu w prawym dolnym rogu tej strony. Nasz zespół chętnie ci pomoże.