---
title: "Integracje"
canonical: "https://support.loyaltystarter.io/space/BW/529203296/Integracje"
format: markdown
---
| Loyalty Starter zapewnia szereg narzędzi umożliwiających integrację z innymi systemami IT.
W niniejszym artykule opisaliśmy nastepujące sposoby integracji:
> Macro (toc) |
| --- |
## API REST
API REST (Representational State Transfer) to interfejs programistyczny, który pozwala na komunikację między aplikacjami. Jest to zbiór zasad dotyczących komunikacji między klientem a serwerem. API REST działa na zasadzie zapytań klienta do serwera i odpowiedzi serwera na te zapytania.
Loyalty Starter posiada wbudowany interfejs API REST. Jego aktualną dokumentację wraz z możliwością przeprowadzenia testów znajdziesz pod tym adresem:
> ℹ️ [https://app.swaggerhub.com/apis/loyaltystarter/loyalty-starter_open_api/](https://app.swaggerhub.com/apis/loyaltystarter/loyalty-starter_open_api/)
Autoryzacja do API odbywa się z wykorzystaniem protokołu OAuth 2.0. Podczas autoryzacji należy podać następujące parametry: ***client_id****, ****client_secret**** *oraz* ****scope**** *(czyli poziom dostępu). Parametr *scope *przyjmuje dwie wartości: ***read*** (dla wszystkich metod typu GET) oraz ***write*** (dla metod typu POST, PUT, PATCH, DELETE).
Zestaw parametrów niezbędnych do autoryzacji w API należy wygenerować w panelu administracyjnym Loyalty Starter. Aby to zrobić:
1. Przejdź do zakładki **Integracje i automaty → API**.
2. Kliknij przycisk **Dodaj aplikację**
3. Otworzy się okno z formularzem konfigurowania aplikacji, która uzyska dostęp do API.
Uzupełnij następujące pola:
- **Aktywny** - żeby zewnętrzna aplikacja miała dostęp do API, ustaw wartość *Tak; *w każdej chwili możesz zabrać dostęp zmieniając wartość tego pola na *Nie,*
- **Nazwa** - wpisz nazwę aplikacji, która będzie korzystała z API,
- **Dostęp** - wybierz preferowany poziom dostępu,
- **Ograniczenie IP** - zmieniając wartość tego pola na *Tak, *możesz wskazać konkretne adresy IP, które będą miały dostęp do API; warto skorzystać z tej możliwości, aby ograniczyć ryzyko wycieku danych osobowych,
- **Adresy IP** - jeśli w poprzednim polu ustawiona została wartość *Tak, *w prowadź adresy IP, które bedą miały zapewniony otwarty dostęp do API.
4. Zapisz formularz z konfiguracją aplikacji, klikając przycisk **Zapisz**.
5. Loyalty Starter automatycznie wygeneruje unikalne parametry *client_id *oraz *client_id, *które są niezbędne do połączenia Twojej aplikacji z Loyalty Starter. Parametr *client_id* możesz skopiować bezpośrednio z tabeli z listą aplikacji. Aby pobrać parametr ***client_secret***, kliknij przycisk *Pokaż *i* *wprowadź hasło do Twojego konta Loyalty Starter.
## Gotowe wtyczki integracyjne
Loyalty Starter posiada gotowe wtyczki integracyjne do systemów sprzedaży **Subiekt GT **oraz **Subiekt Nexo**. Aby dowiedzieć się więcej [skontaktuj się z nami](https://loyaltystarter.io/kontakt/) lub załóż zgłoszenie w [centrum pomocy Loyalty Starter.](https://ibso.atlassian.net/servicedesk/customer/portals)
## Webhooki
Webhooki to mechanizm, który pozwala na automatyczne powiadamianie zewnętrznych aplikacji o zdarzeniach mających miejsce na platformie Loyalty Starter. Webhooki działają na zasadzie publikowania informacji na zdefiniowanym URL-u, na którym nasłuchuje zewnętrzna aplikacja.
Różnica między webhookami a API REST polega na tym, że webhooki są mechanizmem, który inicjuje komunikację do zewnętrznej aplikacji, wysyłając powiadomienie o zaistniałych zdarzeniach, podczas gdy API REST działa na zasadzie klient-serwer, gdzie klient inicjuje zapytania do serwera w celu uzyskania odpowiedzi. W przypadku webhooków, to serwer wysyła powiadomienie do zewnętrznej aplikacji, podczas gdy w przypadku API REST, to klient inicjuje zapytania do serwera w celu pobrania danych lub wykonania akcji. Innymi słowy, webhooki są "push", podczas gdy API REST jest "pull".
W Loyalty Starter webhooki wykorzystywane są jako akcje scenariuszy [Marketing automation](https://ibso.atlassian.net/wiki/spaces/BW/pages/529104980). W ten sposób informacja o dowolnym zdarzeniu, wykrytym przez Loyalty Starter może być przekazana do zewnętrznego systemu.
Aby, skonfigurować webhooka, tworząc lub edytując scenariusz marketing automation, dodaj akcję *Webhook*. W poniższym przykładzie skonfigurujemy webhooka, który będzie uruchamiany po każdorazowym dodaniu punktów.
Konfigurując webhooka musisz podać następujące informacje:
- POST Url - adres na który zostanie wysłany komunikat POST wraz z danymi dotyczącymi zdarzenia w postaci JSON. Adres musi zawierać protokół [https://.](#)
- Nagłówki HTTP - nagłówki, oddzielone enterem, które zostaną przekazane wraz z zapytaniem np.: Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l.
Dodatkowo, w polu *Przykład requesta dla wybranego zdarzenia *możesz sprawdzić jaki dokładnie komunikat zostanie przekazany na podany przez Ciebie adres URL po wykryciu zdarzenia skonfigurowanego w scenariuszu marketing automation. Składka danych i jej atrybuty różnią się pomiędzy zdarzeniami.
## Parser dokumentów sprzedaży
Loyalty Starter posiada gotowy moduł parsera dokumentów sprzedaży. Umożliwia on naliczenie punktów lojalnościowych na podstawie raportów sprzedaży (czyli plików CSV lub XLS zawierających informacje o zakupach klientów).
### Specyfikacja pliku z raportem sprzedaży
- Plik tekstowy
- Dowolny format, przy czym preferowany jest standard CSV
- Kodowanie dowolne, przy czym preferowane jest kodowanie UTF-8
- W pliku mogą znaleźć się dane z poprzednich dni (punkty zostaną przyznane tylko raz, nawet jeśli dane z paragonu pojawią się w kilku plikach)
### Standardowy zestaw kolumn raportu sprzedaży
- Numer karty lojalnościowej - wymagane, jeśli identyfikacja klienta nie odbywa się po innej danej (np. numerze NIP)
- Numer dokumentu sprzedaży
- Data sprzedaży
- Typ dokumentu (faktura, korekta, paragon)
- Wartość - sumaryczna wartość sprzedaży (netto lub brutto - w zależności od tego jak będą wyliczane punkty)
- Symbol lokalizacji / sklepu / oddziału
W powyższym schemacie jeden wiersz w pliku to jeden dokument sprzedaży.
### Alternatywny zestaw kolumn raportu sprzedaży
- Numer karty lojalnościowej
- Numer dokumentu sprzedaży
- Data sprzedaży
- Typ dokumentu (faktura, korekta, paragon)
- Nazwa towaru
- Symbol towaru
- Nazwa lub symbol grupy towarowej (jeśli ma być stosowany indywidualny przelicznik punktowy dla poszczególnych grup towarowych)
- Liczba sztuk
- Cena (netto lub brutto - w zależności od tego jak będą wyliczane punkty)
- Wartość (netto lub brutto - w zależności od tego jak będą wyliczane punkty)
- Symbol lokalizacji / sklepu / oddziału
W tym przypadku jeden wiersz to jedna pozycja na dokumencie sprzedaży.
Taki schemat stosowany jest, jeśli produkty z różnych grup towarowych mają mieć różne przeliczniki punktów lub gdy nazwy zakupionych produktów będą wykorzystywane do segmentacji bazy klientów.
Aby dowiedzieć się więcej [skontaktuj się z nami](https://loyaltystarter.io/kontakt/) lub załóż zgłoszenie w [centrum pomocy Loyalty Starter.](https://ibso.atlassian.net/servicedesk/customer/portals)
## Wtyczka Multivoucher
Wtyczka umożliwia automatyczne dodawanie do katalogu nagród voucherów z platformy Multivoucher.pl. Domyślne parametry nagród konfigurowane w poniżej zaprezentowanym formularzu (takie jak przelicznik punktów, kategoria, grupa i segment klientów, a także limit na klienta i dostępność czasowa nagród) mają zastosowanie wyłącznie podczas dodawania nagród. Aktualizacja tych parametrów odbywa się ręcznie w panelu administracyjnym Loyalty Starter.
Dane *Username* oraz *Password *otrzymasz od przedstawiciela Multivoucher.
Aby dowiedzieć się więcej [skontaktuj się z nami](https://loyaltystarter.io/kontakt/).
**Zastanawiasz się, w jaki sposób klienci otrzymają informacje o zamówionym voucherze?**
Po złożeniu zamówienia klient automatycznie otrzyma powiadomienie w Module Klienta lub Aplikacji, zawierające wszystkie niezbędne informacje.
W każdej chwili może wrócić do tych danych w zakładce *Historia zamówionych nagród*. Upewnij się jednak, że ta zakładka jest widoczna w menu Modułu Klienta — instrukcję, jak to zrobić, znajdziesz [tutaj].
Dodatkowo klient może otrzymać informacje o voucherze drogą mailową. W tym celu należy skonfigurować odpowiedni scenariusz w Marketing Automation.
**Jak to zrobić?**
1. Przejdź do **Ustawienia → Marketing automation → Zdarzenia** i dodaj nowe zdarzenie wyzwalane żądaniem.
2. Skopiuj ID utworzonego zdarzenia i wklej je w zakładce *Multivoucher*.
3. Następnie przejdź do **Ustawienia → Marketing automation → Scenariusze** i utwórz nowy scenariusz, oparty na dodanym wcześniej zdarzeniu.
4. W treści wiadomości e-mail użyj odpowiedniego tagu - **{order_message}**, aby klient otrzymał wszystkie informacje dotyczące zamówionego vouchera.
## Integracje dedykowane
Jeśli Twoje wymagania dotyczące integracji programu lojalnościowego z innymi systemami w Twojej firmie przekraczają możliwości standardowych rozwiązań, nasz zespół programistów może wykonać dla Ciebie dedykowaną integrację. Aby dowiedzieć się więcej [skontaktuj się z nami](https://loyaltystarter.io/kontakt/) lub załóż zgłoszenie w [centrum pomocy Loyalty Starter.](https://ibso.atlassian.net/servicedesk/customer/portals)
## Wtyczka MailerLite
MailerLite to narzędzie do tworzenia i wysyłki kampanii email-marketingowych. W Loyalty Starter dostępna jest wtyczka integracyjna, która umożliwia przekazywanie danych uczestników programu lojalnościowego do tego systemu, w tym ich adresów email.
Aby móc z niej korzystać, [skontaktuj się z nami](https://loyaltystarter.io/kontakt/).