Masowy import przekierowań 301 do sklepu za pośrednictwem API

Import przekierowań za pomocą API nie jest objęty wsparciem technicznym.

  1. Przygotowanie narzędzi pomocnych do tworzenia przekierowań 301 dla sklepów na platformie Shoper
  2. 1.1. Instalacja programu Postman
    Postman to darmowa aplikacja, która pozwala testować API. Narzędzie jest na tyle intuicyjne, że bez problemu mogą z niego korzystać osoby z podstawową wiedzą programistyczną. Aplikację można pobrać tutaj.

    1.2. Dostęp do sklepu i WebAPI
    Wytyczne, w jaki sposób uzyskać dostęp do WebAPI są dostępne tutaj.

    1.3. Dostęp do dokumentacji technicznej
    Pełna dokumentacja techniczna oprogramowania Shoper jest dostępna tutaj.

    1.4. Plik CSV z odpowiednio skonstruowaną strukturą przekierowań
    Pobierz szablonstruktury przekierowań.

  3. Import gotowego środowiska
  4. Stworzyliśmy gotowe środowisko Shoper Environment, dzięki któremu w łatwy sposób wykorzystasz zmienne środowiskowe, potrzebne do łatwiejszej autoryzacji połączenia ze sklepem. Pobierz plik ze środowiskiem.

    2.1. Jak zaimportować środowisko?

    a. Kliknij w ikonę ustawień środowiska:

    b. Następnie kliknij w przycisk Import i wybierz wcześniej pobrany plik z dysku Shoper Environment.postman_environment.json:

    c. Uzupełnij dane sklepu, z którym chcesz nawiązać połączenie.

    Kliknij w ikonę ustawień środowiska:

    Następnie kliknij w nazwę środowiska Shoper Environment:

    Uzupełnij najważniejsze dane:

    • shop_url (adres sklepu),
    • login (login administratora z dostępem do WebAPI),
    • password (hasło administratora).

  5. Import kolekcji i generowanie tokena
  6. Token to klucz niezbędny do połączenia ze sklepem za pomocą REST API. Można go uzyskać wysyłając request typu POST na zasób Auth przy pomocy podstawowej autoryzacji (BASIC AUTH), czyli podając login i hasło sklepu.

    Stworzyliśmy gotową kolekcję zawierającą następujące requesty:

    • POST login/password – request wykorzystuje adres sklepu, login, hasło zapisane w środowisku do wygenerowania tokena {{access_token}}.
    • GET product-images – request pobierający informację o zdjęciach produktów. Jest to przykładowy request zawierający zmienną z tokenem w zakładce Authorization > Type > Bearer Token > {{access_token}}, czyli przekazanie tokena z powyższego requesta POST login/password.

    W obrębie środowiska Shoper Environment możesz tworzyć requesty wykorzystując zmienną {{access_token}}, aby w łatwy i przyjemny sposób autoryzować się ze sklepem.

    3.1. Jak zaimportować kolekcję?

    a. Pobierz przykładową kolekcję.

    b. Kliknij w przycisk Import:

    c. Przeciągnij i upuść w zaznaczonym obszarze plik API Rest Shoper-login.postman_collection.json lub wciśnij Choose Files aby wybrać plik z lokalnego dysku:

    d. Zaimportowana kolekcja znajdzie się w lewym sidebarze w zakładce Collections:

  7. Przykład wykorzystania API
  8. Na poniższym przykładzie pokażemy w jaki sposób dodać przekierowania z wykorzystaniem metody Redirects: insert.

    Aby dodać przekierowanie potrzebujemy wysłać następujące wartości:

    Aby dodać przekierowania należy wysłać powyższe dane za pomocą metody Insert – POST na zasób: /webapi/rest/redirects.

    4.1. Konfiguracja w programie Postman

    a. Uruchom oprogramowanie Postman.

    b. Utwórz Request:

    c. Określ nazwę i miejsce, w którym chcesz zapisać Request:

    d. Wybierz rodzaj requesta, którego będziesz wysyłał na serwer. Zgodnie z zapisami z dokumentacji potrzebujemy zastosować rodzaj typu POST:

    e. W polu URL wprowadź adres sklepu oraz zasób, z którego będziesz korzystać:

    4.2. Body – ciało requesta, czyli informacje, które chcemy wysłać na serwer

    a. Metoda Insert wymaga podania identyfikatora obiektu, dla którego chcemy zrobić przekierowanie. W przypadku innych metod istnieje informacja o wymagalności pola (Mandatory).

    b. Aby móc zaimportować dane z pliku CSV, należy utworzyć zmienne, które będą dokładnie takie same jak nazwy pól w pliku CSV.

    c. Wykorzystywane wartości:

    {{type}} – typ przekierowania

    Dostępne wartości:
    0 – przekierowanie na własny adres URL
    1 – przekierowanie na produkt
    2 – przekierowanie na kategorię
    3 – przekierowanie na producenta
    4 – przekierowanie na stronę informacyjną
    5 – przekierowanie na wpis bloga
    6 – przekierowanie na kategorię bloga

    {{route}} – ścieżka, z której chcemy dokonać przekierowania
    {{object}} – ID obiektu, na który przekierujemy ścieżkę z route
    {{lang_id}} – ID języka, na który ma kierować przekierowanie

    Przykład 1: Chcemy utworzyć przekierowanie na produkt o ID 1795 dla języka polskiego

    Zmienne powinny zawierać następujące wartości:

    {{type}} – 1
    {{route}} – “/product/woman/underwear/3237861/3”
    {{object}} – 1795
    {{lang_id}} – 1


    Przykład 2: Chcemy utworzyć przekierowanie na stronę informacyjną o ID 2 dla języka angielskiego

    Zmienne powinny zawierać następujące wartości:

    {{type}} – 4
    {{route}} – “/howtobeamillionare.html”
    {{object}} – 2
    {{lang_id}} – 2


    Uwaga!
    Każdy obiekt w sklepie ma swoje indywidualne ID. W przypadku produktów ID nie można mylić z kodem produktu, ponieważ są to dwie różne dane. W przypadku języków, język polski ma zwykle ID: 1, angielski ID:2, natomiast każde kolejne mają ID odpowiednio wyższe, zgodnie z zasadami inkrementacji.


    4.3. Wysyłanie requestów na serwer – podsumowanie

    a. Typ requesta: POST.

    b. URL zasobu, na który chcemy wysłać request: https://mojsklep.shoparena.pl/webapi/rest/redirects.

    c. Autoryzacja: Authorization > Bearer Token > Token – {{access_token}}

    d. Ciało requesta – Body

    {
    “type”: “{{type}}”,
    “route”: “{{route}}”,
    “object”: “{{object}}”,
    “lang_id”: “{{lang_id}}”
    }

    e. Uruchom kolekcję, którą chcesz wykonać:

    f. Wprowadź informację o pliku i zweryfikuj jego poprawność:

    Iterations – Wprowadź ilość Requestów(pozycji w pliku CSV do wykonania)

    Delay – Czas odstępu między requestami w milisekundach. Parameter jest niezbędny w przypadku środowisk z dużymi ograniczeniami jeżeli chodzi o ilość wysyłanych requestów w określonym czasie. Dla bezpieczeństwa można dać wartość 200-400 ms

    Log Response – Dowolnie konfigurowalna opcja zapisu logów operacji

    Data – Plik CSV wrzucony z lokalnego dysku

    Data File Type – Typ pliku, który wprowadzamy, w przypadku pliku CSV wybierz text/csv

    Preview – Narzędzie pozwalające zweryfikować, czy plik CSV został poprawnie odczytany przez Postman

    g. Uruchamiamy operację, klikając w Run Export:

    h. W oczekiwaniu na Response (czyli odpowiedź serwera na wysłane zapytanie):

    i. Po zakończeniu operacji pojawi się raport o wykonanej operacji:

    Kody błędów i wiadomości można sprawdzić na stronie Shoper Developers.

    Poradnik opracował Sławomir Zborowski, Reseller Support Specialist, reseller@shoper.pl

Czy artykuł okazał się pomocny?
TAK
NIE

W jaki sposób możemy poprawić jakość tego artykułu?

+ = Udowodnij, że nie jesteś robotem 🙂