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

Dokument WSDL dostępny jest pod adresem http://<TwojAdresSklepu>/webapi/soap/?wsdl

Dla platformy .net dokument WSDL dostępny jest pod adresem http://<TwojAdresSklepu>/webapi/net-soap/?wsdl - Dostępne od wersji 1.0.15

Interfejs dostępny jest pod adresem http://<TwojAdresSklepu>/webapi/soap/

Dla platformy .net interfejs dostępny jest pod adresem http://<TwojAdresSklepu>/webapi/net-soap/ - Dostępne od wersji 1.0.15

Dostępne od wersji 1.0.15

Interfejs dostępny jest pod adresem http://<TwojAdresSklepu>/webapi/json/

Ze względu na wydajność interfejs JSON jest preferowanym interfejsem w komunikacji ze sklepem.

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

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

• 1.0.15
• 1.1.1

• login - logowanie i rozpoczęcie sesji
• logout - wylogowanie zakończenie sesji
• call - wywołanie wybranej metody modułu
• checkApplicationLock - sprawdzenie blokady aplikacji
• aquireApplicationLock - ustawienie blokady aplikacji
• updateApplicationLock - odświeżenie blokady aplikacji
• releaseApplicationLock - zwolnienie blokady aplikacji
• getApplicationLock - pobranie danych o blokadzie aplikacji
• checkObjectLock - sprawdzenie blokady obiektu
• checkObjectModificationTime - sprawdzenie czasu modyfikacji obiektu
• checkObjectListModificationTime - sprawdzenie czasu modyfikacji listy obiektów tego samego typu

• internals.time - pobranie znacznika czasu z serwera
• internals.version - pobranie numeru wersji oprogramowania
• internals.phpinfo - pobranie wygenerowanego kodu html z funkcji phpinfo()

• product.info - pobranie informacji o produkcie
• product.create - utworzenie produktu
• product.delete - usunięcie produktu
• product.save - zapisanie informacji o produkcie
• product.list - pobranie listy produktów
• product.list.filter - pobieranie identyfikatorów produktów spełniających dane kryteria
• product.list.create - utworzenie podanej listy produktów
• product.list.save - zapisanie listy produktów
• product.list.delete - usunięcie listy produktów
• product.translation - pobranie tłumaczenia produktu
• product.translation.save - zapisanie tłumaczenia produktu
• product.translations.save - zapisanie listy tłumaczeń produktu
• product.categories - pobranie listy identyfikatorów kategorii, do których przypisany jest produkt
• product.categories.attach - dowiązanie produktu do podanych kategorii
• product.categories.detach - usunięcie dowiązań produktu do podanych kategorii
• product.attributes - pobranie informacji o atrybutach produktu
• product.attributes.save - ustawianie wartości atrybutów produktu
• product.options - pobranie listy identyfikatorów dodatkowych wariantów produktu
• product.option - pobranie wariantu produktu
• product.option.create - utworzenie wariantu produktu
• product.option.save - zapisanie wariantu produktu
• product.option.delete - usunięcie wariantu produktu
• product.option.list - pobranie listy wariantów produktu
• product.option.list.create - utworzenie listy wariantów produktu
• product.option.list.save - zapisanie listy wariantów produktu
• product.option.list.delete - usunięcie listy wariantów produktu
• product.stock - pobranie informacji o domyślnym wariancie produktu
• product.stock.list - pobranie informacji o domyślnym wariancie dla listy produktów
• product.images - pobranie listy zdjęć produktu
• product.images.order - zmiana kolejności zdjęć produktu
• product.image.exists - sprawdzenie czy produkt posiada zdjęcie o podanej sumie kontrolnej md5
• product.image.save - zapisanie informacji o zdjęciu produktu
• product.image.delete - usunięcie zdjęcia produktu
• product.image.list.delete - usunięcie listy zdjęć produktu
• product.image.list.save - zapisuje listę zdjęć produktów
• product.files - pobranie listy plików produktu
• product.files.order - zmiana kolejności plików produktu
• product.file.save - zapisanie informacji o pliku produktu
• product.file.delete - usunięcie pliku produktu
• product.file.list.delete - usunięcie listy plików produktu

• category.info - pobranie informacji o kategorii
• category.save - zapisanie kategorii
• category.create - utworzenie kategorii
• category.delete - usunięcie kategorii
• category.translation - pobranie informacji o tłumaczeniu kategorii
• category.translation.save - zapisanie tłumaczenia kategorii
• category.translations.save - zapisanie tłumaczeń kategorii
• category.list - pobranie listy kategorii
• category.list.create - utworzenie listy kategorii
• category.list.save - zapisanie listy kategorii
• category.list.delete - usunięcie listy kategorii
• category.tree - pobranie drzewa kategorii

• attribute.group.info - pobranie informacji o grupie atrybutów
• attribute.group.create - utworzenie grupy atrybutów
• attribute.group.save - zapisanie grupy atrybutów
• attribute.group.delete - usunięcie grupy atrybutów
• attribute.group.list - pobranie listy grup atrybutów
• attribute.group.list.create - utworzenie listy grup atrybutów
• attribute.group.list.save - zapisanie listy grup atrybutów
• attribute.group.list.delete - usunięcie listy grup atrybutów
• attribute.info - pobranie atrybutu
• attribute.create - utworzenie atrybutu
• attribute.save - zapisanie atrybutu
• attribute.delete - usunięcie atrybutu
• attribute.list - pobranie listy atrybutów
• attribute.list.create - utworzenie listy atrybutów
• attribute.list.save - zapisanie listy atrybutów
• attribute.list.delete - usunięcie listy atrybutów

• producer.info - pobranie informacji o producencie
• producer.create - utworzenie producenta
• producer.save - zapisanie producenta
• producer.delete - usunięcie producenta
• producer.list - pobranie listy producentów
• producer.list.create - utworzenie listy producentów
• producer.list.save - zapisanie listy producentów
• producer.list.delete - usunięcie listy producentów

• option.group.info - pobranie informacji o grupie cech
• option.group.create - utworzenie grupy cech
• option.group.save - zapisanie grupy cech
• option.group.delete - usunięcie grupy cech
• option.group.translation - pobranie tłumaczenia grupy cech
• option.group.translation.save - zapisanie tłumaczenia grupy cech
• option.group.translations.save - zapisanie listy tłumaczeń grupy cech
• option.group.list - pobranie listy grup cech
• option.group.list.create - utworzenie listy grup cech
• option.group.list.save - zapisanie listy grup cech
• option.group.list.delete - usunięcie listy grup cech
• option.info - pobranie cechy
• option.create - utworzenie cechy
• option.save - zapisanie cechy
• option.delete - usunięcie cechy
• option.translation - pobranie tłumaczenia cechy
• option.translation.save - zapisanie tłumaczenia cechy
• option.translations.save - zapisanie listy tłumaczeń cechy
• option.list - pobranie listy cech
• option.list.create - utworzenie listy cech
• option.list.save - zapisanie listy cech
• option.list.delete - usunięcie listy cech
• option.values - pobranie listy wariantów danej cechy
• option.value.info - pobranie informacji o wariancie
• option.value.create - utworzenie wariantu
• option.value.save - zapisanie wariantu
• option.value.delete - usunięcie wariantu
• option.value.translation - pobranie tłumaczenia wariantu
• option.value.translation.save - zapisanie tłumaczenia wariantu
• option.value.translations.save - zapisanie listy tłumaczeń wariantu
• option.value.list.create - utworzenie listy wariantów
• option.value.list.save - zapisanie listy wariantów
• option.value.list.delete - usunięcie listy wariantów

• availability.info - pobranie informacji o dostępności
• availability.translation - pobranie tłumaczenia dostępności
• availability.list - pobranie listy dostępności

• delivery.info - pobranie informacji o czasie dostawy
• delivery.translation - pobranie tłumaczenia czasu dostawy
• delivery.list - pobranie listy czasów dostaw

• order.info - pobranie informacji o zamówieniu
• order.products - pobranie listy produktów z zamówienia
• order.list - pobranie listy zamówień
• order.list.filter - pobieranie identyfikatorów zamówień spełniających dane kryteria
• order.new.list - pobranie listy nowych zamówień
• order.save - zapisanie informacji o zamówieniu
• order.list.save - zapisanie listy zamówień

• shipping.info - pobranie informacji o metodzie dostawy
• shipping.payments - pobranie listy płatności obsługiwanych przez tą dostawę
• shipping.ranges - pobranie przedziałów cenowych dostawy
• shipping.list - pobranie listy metod dostaw

• payment.info - pobranie informacji o metodzie płatności
• payment.translation - pobranie tłumaczenia metody płatności
• payment.currencies - pobranie listy walut obsługiwanych przez tą płatność
• payment.list - pobranie listy metod płatności

• tax.info - pobranie informacji o stawce podatkowej
• tax.list - pobranie listy stawek podatkowych

• unit.info - pobranie informacji o jednostce miary
• unit.save - zapisanie jednostki miary
• unit.create - utworzenie jednostki miary
• unit.delete - usunięcie jednostki miary
• unit.translation - pobranie tłumaczenia jednostki miary
• unit.translation.save - zapisanie tłumaczenia jednostki miary
• unit.translations.save - zapisanie tłumaczeń jednostki miary
• unit.list - pobranie listy jednostek miar
• unit.list.create - utworzenie listy jednostek miar
• unit.list.save - zapisanie listy jednostek miar
• unit.list.delete - usunięcie listy jednostek miar

• currency.info - pobranie informacji o walucie
• currency.list - pobranie listy walut

• locale.info - pobranie informacji o lokalizacji
• locale.list - pobranie listy lokalizacji

• Pobieranie identyfikatorów produktów
• Aktualizacja stanów magazynowych
• Zarządzanie atrybutami
• Zarządzanie wariantami