Moduł Seller

Pobranie listy programów lojalnościowych

Metoda zwraca wszystkie programy lojalnościowe, do których ma uprawnienia użytkownik.

Wywołanie:

https://connect.klubklienta.pl/seller/programs

Wartość zwracana:

• array

  lista programów jako obiektów o właściwościach:
  id - identyfikator programu (int)
  name - nazwa programu (string)
  companyName - nazwa organizatora (string)

Pobranie informacji o programie lojalnościowym

Wywołanie:

https://connect.klubklienta.pl/seller/program/[programId]

Parametry:

• programId (int)

  identyfikator programu

Wartość zwracana:

• object

  definicja programu lojalnościowego, obiekt o właściwościach:
  id - identyfikator programu (int)
  name - nazwa programu (string)
  companyName - nazwa organizatora (string)
  descr - opis programu lub slogan reklamowy (string)
  startPrize - opis nagrody powitalnej lub punktów powitalnych (string)
  recommendPoints - liczba punktów za polecenie programu (int)
  collectPointsTo - data zakończenia programu (date)
  receivePrizesTo - data zakończenia odbioru nagród (data)

Pobranie listy definicji punktów za zakupy

Wywołanie:

https://connect.klubklienta.pl/seller/points/[programId]

Parametry:

• programId (int)

  identyfikator programu

Wartość zwracana:

• array

  lista definicji punktów jako obiektów o właściwościach:
  tag - kod definicji punktów (string)
  name - nazwa definicji punktów (string)
  type - typ definicji (int): 1 - przypisany do zakupu; 2 - zależny od kwoty zakupów
  points - liczba punktów za zakupy (int)
  amount - w przypadku, gdy type = 2, oznacza kwotę, której wielokrotność uprawnia do otrzymania punktów
  subject - jednostka zakupu (string), np. minutę, sztukę, seans, usługę
  descr - opis definicji punktów (string)
  label - opis definicji punktów przyjazny dla klienta (string); wygenerowany automatycznie na podstawie właściwości: name, type, points, amount i subject

Pobranie pojedynczej definicji punktów za zakupy

Wywołanie:

https://connect.klubklienta.pl/seller/point/[programId]/[tag]

Parametry:

• programId (int)

  identyfikator programu

• tag (string)

  kod definicji punktów

Wartość zwracana:

• array

  definicja punktów jako obiekt:
  tag - kod definicji punktów (string)
  name - nazwa definicji punktów (string)
  type - typ definicji (int): 1 - przypisany do zakupu; 2 - zależny od kwoty zakupów
  points - liczba punktów za zakupy (int)
  amount - w przypadku, gdy type = 2, oznacza kwotę, której wielokrotność uprawnia do otrzymania punktów
  subject - jednostka zakupu (string), np. minutę, sztukę, seans, usługę
  descr - opis definicji punktów (string)
  label - opis definicji punktów przyjazny dla klienta (string); wygenerowany automatycznie na podstawie właściwości: name, type, points, amount i subject

Pobranie listy nagród

Wywołanie:

https://connect.klubklienta.pl/seller/prizes/[programId]

Parametry:

• programId (int)

  identyfikator programu

Wartość zwracana:

• array

  lista nagród jako obiektów o właściwościach:
  tag - kod nagrody (string)
  name - nazwa nagrody (string)
  type - typ nagrody (int): 1 - zniżka procentowa, 2 - rabat kwotowy, 3 - gratis, 4 - prezent
  points - wartość punktowa nagrody (int)
  availableCnt - liczba dostępnych sztuk nagrody (int)
  onlyForSeller - nagroda dostępna tylko w panelu sprzedawcy (bool)
  descr - opis nagrody (string)
  label - opis nagrody przyjazny dla klienta (string); wygenerowany automatycznie na podstawie właściwości: name, type, points

Pobranie informacji o pojedynczej nagrodzie

Wywołanie:

https://connect.klubklienta.pl/seller/prize/[programId]/[tag]

Parametry:

• programId (int)

  identyfikator programu

• tag (string)

  kod nagrody

Wartość zwracana:

• array

  definicja nagrody jako obiekt o właściwościach:
  tag - kod nagrody (string)
  name - nazwa nagrody (string)
  type - typ nagrody (int): 1 - zniżka procentowa, 2 - rabat kwotowy, 3 - gratis, 4 - prezent
  points - wartość punktowa nagrody (int)
  availableCnt - liczba dostępnych sztuk nagrody (int)
  onlyForSeller - nagroda dostępna tylko w panelu sprzedawcy (bool)
  descr - opis nagrody (string)
  label - opis nagrody przyjazny dla klienta (string); wygenerowany automatycznie na podstawie właściwości: name, type, points

Wygenerowanie kodu zaproszenia do programu o okresie ważności 5 minut

Metoda generuje kod zaproszenia do programu. Skanując kod klient przystępuje do programu lojalnościowego. Kod jest jednorazowy i ważny przez 5 minut, powinien być zatem natychmiast zeskanowany lub wpisany przez klienta w aplikacji Klub Klienta.

W przypadku, gdy klient nie może od razu użyć kodu, może on zostać przedłużony metodą extendCode lub wysłany do klienta e-mailem przy użyciu metody sendCode.

Wywołanie:

https://connect.klubklienta.pl/seller/invite/[programId]

Parametry:

• programId (int)

  identyfikator programu

Wartość zwracana:

• object

  wygenerowany kod jako obiekt o właściwościach:
  code - wygenerowany 6-cyfrowy kod (string)
  url - adres, na który należy przekierować użytkownika w celu użycia kodu (string)
  qr - grafika type image/png w formacie inline data:image/png (string)
  title - tytuł do wyświetlenia użytkownikowi (string)
  descr - opis wygenerowanego kodu (string)
  time - opis czasu aktywności kodu (string)

Wygenerowanie kodu punktów za zakupy o okresie ważności 5 minut

Metoda generuje kod, który służy do przekazania klientowi punktów za dokonane zakupy. Kod jest jednorazowy i ważny przez 5 minut, powinien być zatem natychmiast zeskanowany lub wpisany przez klienta w aplikacji Klub Klienta.

W przypadku, gdy klient nie może od razu użyć kodu, może on zostać przedłużony metodą extendCode lub wysłany do klienta e-mailem przy użyciu metody sendCode.

Liczba punktów dla klienta wynika z definicji punktów za zakupy wskazanej parametrem tag.

Wywołanie:

https://connect.klubklienta.pl/seller/givePoints/[programId]/[tag]/[number]

Parametry:

• programId (int)

  identyfikator programu

• tag (string)

  kod definicji punktów

• number (int)

  podstawa wyliczenia punktów za zakupy: liczba zakupionych produktów (dla type = 1) lub kwota zakupu (dla type = 2)

Wartość zwracana:

• object

  wygenerowany kod jako obiekt o właściwościach:
  code - wygenerowany 6-cyfrowy kod (string)
  url - adres, na który należy przekierować użytkownika w celu użycia kodu (string)
  qr - grafika type image/png w formacie inline data:image/png (string)
  title - tytuł do wyświetlenia użytkownikowi (string)
  descr - opis wygenerowanego kodu (string)
  time - opis czasu aktywności kodu (string)

Wygenerowanie kodu przekazania nagrody o okresie ważności 5 minut

Metoda generuje kod, który służy do przekazania klientowi wybranej nagrody. Kod jest jednorazowy i ważny przez 5 minut, powinien być zatem natychmiast zeskanowany lub wpisany przez klienta w aplikacji Klub Klienta.

W przypadku, gdy klient nie może od razu użyć kodu, może on zostać przedłużony metodą extendCode lub wysłany do klienta e-mailem przy użyciu metody sendCode.

Wywołanie:

https://connect.klubklienta.pl/seller/givePrize/[programId]/[tag]

Parametry:

• programId (int)

  identyfikator programu

• tag (string)

  kod nagrody

Wartość zwracana:

• object

  wygenerowany kod jako obiekt o właściwościach:
  code - wygenerowany 6-cyfrowy kod (string)
  url - adres, na który należy przekierować użytkownika w celu użycia kodu (string)
  qr - grafika type image/png w formacie inline data:image/png (string)
  title - tytuł do wyświetlenia użytkownikowi (string)
  descr - opis wygenerowanego kodu (string)
  time - opis czasu aktywności kodu (string)

Wydłużenie okresu ważności kodu

Kod podany w parametrze code zostanie zastąpiony nowym kodem o dwutygodniowym okresie ważności. Umożliwi to późniejsze skorzystanie z kodu przez klienta, który dokonał zakupu. Kod może być np. możliwy do późniejszego zobaczenia z poziomu konta klienta w sklepie internetowym albo wysłany do klienta e-mailem.

Przedłużony kod jest jednorazowy, tzn. klient będzie mógł skorzystać z niego jednokrotnie.

Wywołanie:

https://connect.klubklienta.pl/seller/extendCode/[code]

Parametry:

• code (string)

  kod, który ma zostać przedłużony

Wartość zwracana:

• object

  wygenerowany kod jako obiekt o właściwościach:
  code - wygenerowany 9-cyfrowy kod (string)
  url - adres, na który należy przekierować użytkownika w celu użycia kodu (string)
  qr - grafika type image/png w formacie inline data:image/png (string)
  title - tytuł do wyświetlenia użytkownikowi (string)
  descr - opis wygenerowanego kodu (string)
  time - opis czasu aktywności kodu (string)

Wysłanie e-mailem kodu wraz instrukcjami jego użycia

Metoda powoduje wysłanie na wskazany e-mail wiadomości dla klienta wygenerowanej w platformie Klub Klienta. Wiadomość taka zawiera: informacje o programie lojalnościowym, przekazany kod w postaci numerycznej i kodu QR, odnośnik do strony informacyjnej z pełnym opisem programu lojalnościowego oraz instrukcję użycia przekazanego kodu w aplikacji Klub Klienta.

Jeśli w parametrach zostanie podany kod krótki (5-minutowy), przed wysłaniem zostanie on zastąpiony kodem 2-tygodniowym, analogicznie jak w metodzie extendCode.

Wywołanie:

https://connect.klubklienta.pl/seller/sendCode/[code]/[recipient]

Parametry:

• code (string)

  kod, który ma zostać wysłany

• recipient (string), opcjonalny

  adres, na który ma zostać wysłany e-mail

Wartość zwracana:

• object

  potwierdzenie w postaci obiektu o właściwościach:
  success - flaga pozytywnego rezultatu wysyłki (bool)
  title - tytuł komunikatu (string)
  message - komunikat potwierdzenia (string)

Sprawdzenie statusu wygenerowanego kodu

Metoda umożliwia sprawdzenie, czy wygenerowany kod został użyty przez adresata. Wywołanie metody jest blokujące. Jeśli kod pozostaje aktywny (nie został użyty przez adresata), to czas, po którym metoda zwróci rezultat wynosi 20 sekund. Jeśli w tym czasie nastąpi użycie kodu, jego wygaśnięcie lub anulowanie, rezultat jest natychmiast zwracany.

Takie rozwiązanie pozwala na zminimalizowanie liczby odwołań do Connect API a równocześnie gwarantuje natychmiastową informację o wykorzystaniu kodu.

Wywołanie:

https://connect.klubklienta.pl/seller/checkCodeStatus/[code]

Parametry:

• code (string)

  kod, który ma zostać sprawdzony

Wartość zwracana:

• string

  status kodu, może przyjąć następujące wartości:
  "active" - kod jest aktywny (nie został odebrany przez odbiorcę)
  "used" - kod został użyty przez odbiorcę
  "timeout" - ważność kodu wygasła
  "invalid" - kod nie został odnaleziony (np. podano nieprawidłowy kod do sprawdzenia) lub wystąpił błąd

Pobranie informacji o kodzie odbioru nagrody

Metoda służy do pobrania informacji o kodzie wygenerowanym przez klienta w aplikacji mobilnej Klub Klienta funkcją "Odbierz nagrodę". Ma na celu po pierwsze weryfikację prawidłowości kodu, a ponadto umożliwia wyświetlenie informacji o kodzie klientowi, aby mógł on potwierdzić chęć jego użycia w sklepie internetowym. Przed akceptacją użycia kodu przez klienta oprogramowanie sklepu powinno wyświetlić klientowi informację o korzyści wynikającej z odebrania nagrody (użycia kodu). Do celów takiej weryfikacji można użyć identyfikatora nagrody (właściwość tag zwróconego rezultatu).

Korzystając ze zwróconego identyfikatora nagrody (tag), oprogramowanie sklepu może też zweryfikować, czy wybrana przez klienta nagroda jest przewidziana do zrealizowania w bieżącym sklepie. W przypadku negatywnej weryfikacji stosowny komunikat powinien zostać wyświetlony klientowi.

Wywołanie:

https://connect.klubklienta.pl/seller/checkCode/[code]

Parametry:

• code (string)

  kod odbioru nagrody wygenerowany w aplikacji klienta

Wartość zwracana:

• object

  informacje o kodzie w postaci obiektu o właściwościach:
  title - nazwa kodu (string)
  descr - opis kodu (string)
  timeout - liczba sekund pozostała do wygaśnięcia kodu (int)
  programId - identyfikator programu lojalnościowego, z którego pochodzi nagroda
  tag - identyfikator nagrody przypisanej do kodu odbioru

Potwierdzenie kodu realizacji nagrody

Metoda służy do użycia kodu nagrody, który został pozytywnie zweryfikowany metodą checkCode i odbiór nagrody został zatwierdzony przez klienta w witrynie sklepu. Wywołanie metody powinno nastąpić bezpośrednio przed przydzieleniem przez oprogramowanie sklepu korzyści wynikającej z nagrody.

Prawidłowe wywołanie będzie miało skutek w postaci wyświetlenia komunikatu w aplikacji mobilnej Klub Klienta o zrealizowaniu nagrody oraz usunięcia nagrody z konta klienta aplikacji mobilnej.

Wywołanie:

https://connect.klubklienta.pl/seller/confirmCode/[code]

Parametry:

• code (string)

  kod realizacji nagrody wygenerowany w aplikacji klienta

Wartość zwracana:

• object

  potwierdzenie w postaci obiektu o właściwościach:
  success - flaga pozytywnego rezultatu potwierdzenia (bool)
  title - tytuł komunikatu (string)
  message - komunikat potwierdzenia (string)