Początek

Aby zacząć integrację musisz zdobyć swój klucz API oraz symbol klienta, który zostanie przekazany przez naszego managera sprzedaży. W tym celu prosimy o kontakt pod adresem helpdesk@quarticon.com.

Wyślij dane o produkcie

Abyśmy mogli rekomendować produkty z Twojego sklepu musisz przekazać nam dane o nich. Używając API możesz wysyłać nam dane produktów kiedy tylko ulegną modyfikacji.

Do przesłania danych służy metoda: POST /data/product (kliknij by przejść do dokumentacji).

Uwagi

  • Pamiętaj, że w nagłówkach należy przekazać Twój API key, w przeciwnym wypadku nie przejmiemy danych produktu.
  • Parametr catalogSymbol pozostaw pusty. Jest on potrzebny w przypadku, gdy korzystasz z wielu katalogów – np. wielu języków czy wielu walut. W razie takiej potrzeby skontaktuj się z managerem sprzedaży.
  • Jeśli chcesz usunąć produkt po prostu ustaw jego status na false

Dostarcz informacje o odsłonach stron produktów

By dopasować rekomendacje do Twoich klientów musimy wiedzieć jakie produkty ich interesują, a więc musimy wiedzieć jakie produkty oglądają.

Na stronie „productPage” należy przekazać nam informacje skorzystając z metody: POST /track/event (kliknij by przejść do dokumentacji) stosując schemat eventProductView.

Dostarcz dane o sprzedaży

By zapewnić wysoką jakość rekomendacji musimy posiadać informacje o zakupach w Twoim sklepie.

Na stronie „thankYouPage” należy przesłać informacje o transakcji używając metody: POST /track/event (kliknij by przejść do dokumentacji) stosując schemat eventTransaction.

Otrzymaj rekomendacje dla swoich klientów

Aby pobrać rekomendacje dla klientów Twojej aplikacji za pomocą API należy skorzystać z metody: GET /recommendation (kliknij by przejść do dokumentacji).

Uwagi

    • Wyglądem swoich ramek możesz sterować dowolnie, API dostarcza jedynie źródło danych o rekomendacjach.
    • Jeśli chcesz pobrać rekomendacje do produktu, przekaż jego ID w parametrze filterProduct. Jeśli chcesz wyświetlić rekomendacje dla wielu produktów, przekaż ich ID oddzielone przecinkiem w tym samym parametrze.
    • Jeśli chcesz odfiltrować rekomendacje do kategorii, przekaż jej ID w parametrze filterCategory. Jeśli rekomendowane produkty mają znajdować się jednocześnie w kilku kategoriach przekaż ich ID w tym samym parametrze oddzielając je przecinkiem.

Wyślij informacje o kliknięciu na produkt

Gdy ktoś kliknie w rekomendację należy przesłać do nas informację o tym. Można to zrobić za pomocą API korzystając z metody: POST /track/event (kliknij by przejść do dokumentacji) stosując schemat eventClick.

Uwagi

      • Jednym z parametrów schematu eventClick jest trackingString – jest on dołączony do każdego rekomendowanego produktu (pobranego wcześniej przy użyciu metody GET /recommendation). Każdy produkt ma inny trackingString więc zadbaj o to by przekazać ten, którego ta akcja dotyczy.

Informacje ogólne

    • Stosowany w API parametr userId to id zalogowanego użytkownika w Twoim sklepie. Jeśli użytkownik nie jest zalogowany – nie musisz go wysyłać.
    • W każdej z metod należy przekazać nagłówek accept-version – aktualna wersja to 1.0.0 – tę wartość należy przekazać.
    • W większości requestów jeden z parametrów: cookie lub deviceId musi być przesłany – jeden z nich zawsze musi posiadać wartość. Pamiętaj by w każdym innym request-cie używać zawsze tego samego identyfikatora.

> POWRÓT DO STRONY GŁÓWNEJ