REST API

Aktualna dokumentacja nowoczesnego interfejsu rest api jest dostępna pod adresem https://developers.shoper.pl/

REST API - dokumentacja interfejsu



Webapi

Poniższe informacje dotyczą interfejsów, które nie są już rozwijane - nowe aplikacje powinny korzystać z REST API.

Aplikacja udostępnia elastyczne api dla aplikacji chcących wymieniać informacje ze sklepem za pomocą mechanizmu SOAP lub JSON.

Informacje podstawowe

Adres dokumentu WSDL api dla protokołu SOAP

Adres interfejsu SOAP

Adres interfejsu JSON

Dostępne od wersji 5.0.15

Wywoływanie metod interfejsu JSON

Na podany wyżej adres, należy wysłać zapytanie metodą POST z parametrem „json” - który jest zakodowaną w formacie JSON tablicą z parametrami:

  • method - nazwa metody interfejsu do wywołania
  • params - tablica z argumentami metody podanymi w kolejności ich występowania

Jako wynik zapytania, zawsze zwracany jest string - zakodowana odpowiedź w formacie JSON. Jeśli wystąpił wyjątek, odpowiedź będzie zakodowaną tablicą reprezentującą wyjątek:

  • error - komunikat błędu
  • code - kod błędu

Użytkownik z dostępem do webapi

Aby używać mechanizmu webapi, należy przygotować odpowiednie konto administratora. W tym celu należy:

  • Przejść do strony zarządania administratorami w panelu administracyjnym sklepu: Konfiguracja » Administracja, system » Administratorzy
  • Utworzyć grupę administratorów z odpowiednio ustawionym polem „Typ dostępu” na „dostęp do webapi”.
  • Dodać nowego administratora do nowo utworzonej grupy administratorów

Lista metod webapi

Dostępne metody interfejsu
Moduł funkcji systemowych
Moduł zarządzania produktami
Moduł zarządzania kategoriami
Moduł zarządzania atrybutami
Moduł zarządzania producentami
Moduł zarządzania konfiguracją wariantów
Moduł zarządzania dostępnościami produktów
Moduł zarządzania czasem dostaw produktów
Moduł zarządzania zamówieniami
Moduł zarządzania metodami dostaw
Moduł zarządzania metodami płatności
Moduł zarządzania stawkami podatkowymi
  • tax.info - Pobiera informacje o stawce podatkowej
  • tax.list - Pobiera listę stawek podatkowych
Moduł zarządzania jednostkami miar
Moduł zarządzania walutami
Moduł zarządzania lokalizacjami
Dashboard
Moduł zarządzania przesyłkami
Moduł zarządzania subskrybentami
Moduł zarządzania użytkownikami