Web API - Integracje i wymiana danych z innymi programami.

Włączenie WebAPI

Wybierz Konfiguracja

Tylko zwykły administrator może być wykorzystywany do połączenia WebAPI.

1. Zaznacz Włącz WebApi,
2. Ustaw Czas trwania sesji (czas podawany w sekundach),
3. Wybierz czy nieaktualne sesje z listy logowań mają być automatycznie usuwane,
4. Wybierz czy wymusić używanie API przez SSL,
5. Naciśnij przycisk Zapisz.

Logowania WebAPI

Wybierz Logowania WebApi

Funkcje WebAPI w SOTESHOP

Lista funkcji WebApi w zależności od modułu.

Producenci (stProducer)

• AddProducer - dodaje nowego producenta,
• CountProducer - zwraca liczbę producentów,
• DeleteProducer - usuwa producenta,
• GetProducer - pobiera dane producenta,
• GetProducerList - zwraca listę producentów,
• UpdateProducer - aktualizuje dane producenta,

Adres producentów

http://www.shop.example.com/backend.php/producer/soap?wsdl

Kategorie (stCategory)

• AddCategory - dodaje nową kategorię,
• CountCategory - zwraca liczbę kategorii,
• DeleteCategory - usuwa kategorię,
• GetCategory - pobiera dane kategorii,
• GetCategoryList - zwraca listę kategorii,
• UpdateCategory - aktualizuje dane kategorii,

Adres kategorii

http://www.shop.example.com/backend.php/category/soap?wsdl

Produkty (stProduct)

• AddAvailability - dodaje dostępność dla produktu,
• AddProduct - dodaje nowy produkt,
• AddProductImage - dodaje nowe zdjęcie do produktu,
• AddProductPrice - dodaje cenę produktu w wybranej walucie,
• AddTax - dodaje nową stawkę VAT,
• AssignProductToCategory - przypisuje produkt do kategorii,
• CountAvailability - zlicza dostępności,
• CountProduct - zlicza produkty,
• CountProductImage - zlicza zdjęcia dla produktu,
• CountProductOptionsList - zlicza ilość opcji produktu,
• CountProductPrice - zwraca liczbę cen w walutach,
• CountTax - zlicza stawki VAT,
• DeleteAvailability - usuwa dostępność dla produktu,
• DeleteProduct - usuwa produkt,
• DeleteProductImage - usuwa zdjęci produktu,
• DeleteProductPrice - usuwa cenę w walucie,
• DeleteTax - usuwa stawkę VAT,
• GetAvailability - pobiera dostępność dla produktu,
• GetAvailabilityList - pobiera listę dostępności,
• GetProduct - pobiera dane produktu,
• GetProductByCode - pobiera dane produktu,
• GetProductImage - zwraca zdjęcie produktu,
• GetProductImageList - zwraca listę zdjęć produktu,
• GetProductList - zwraca listę produktów,
• GetProductOptionsList - zwraca listę opcji produktu,
• GetProductPrice - pobiera cenę produktu w wybranej walucie,
• GetProductPriceList - pobiera ceny w walucie produktu.,
• GetTax - zwraca stawkę VAT,
• GetTaxList - zwraca listę stawek VAT,
• GetRecommendedList - zwraca listę produktów polecanych,
• GetAccessoriesList - zwraca listę akcesoriów,
• RemoveProductFromCategory - usuwa przypisanie produkt do kategorii,
• UpdateAvailability - aktualizuje dostępność dla produktu,
• UpdateProduct - aktualizuje dane produktu,
• UpdateProductByCode - aktualizuje dane produktu,
• UpdateProductOption - aktualizuje opcje produktu,
• UpdateProductPrice - aktualizuje cenę produktu w wybranej walucie.
• UpdateTax - aktualizuje stawkę VAT,
• UpdateRecommendedList - aktualizuje listę produktów polecanych,
• UpdateAccessoriesList - aktualizuje listę akcesoriów,

Adres produktów

http://www.shop.example.com/backend.php/product/soap?wsdl

Użytkownicy (stUser)

• AddUser - dodaje nowego użytkownika,
• AddUserProfile - dodaje nowy profil klienta,
• CountUser - zwraca liczbę użytkowników,
• CountUserProfile - zwraca liczbę profili klientów,
• DeleteUser - usuwa użytkownika,
• DeleteUserProfile - usuwa profil klienta,
• GetUser - pobiera dane użytkownika,
• GetUserList - zwraca listę użytkowników,
• GetUserProfile - pobiera profil klienta,
• GetUserProfileList - zwraca listę profili klientów,
• UpdateUser - aktualizuje dane użytkownika,
• UpdateUserProfile - aktualizuje profil klienta,

Adres użytkowników

http://www.shop.example.com/backend.php/user/soap?wsdl

Logowania (stWebApiBackend)

• ClearCache - czyszczenie cache,
• doLogin - logowanie do systemu,
• GetVersion - zwraca wersje modułu API,
• Noop - przedłuża sesje i zwraca czas jej zakończenia,
• Test - testowanie komunikacji,

Adres logowań

http://www.shop.example.com/backend.php/webapi/soap?wsdl

Zamówienia (stOrder)

• AddOrder - dodaje nowe zamówienie,
• GetOrder - zwraca szczegółowe dane dotyczące zamówienia,
• GetOrderCount - zwraca liczbę zamówień w sklepie,
• GetOrderList - zwraca listę zamówień,
• GetOrderListByUser (przestarzałe) - zwraca listę zamówień dla wybranego klienta,
• GetOrderByNumber - zwraca zamówienie na podstawie jego numeru,
• GetOrderPayment - pobiera informacji o płatności dla danego zamówienia,
• GetOrderProductList - zwraca listę produktów w zamówieniu,
• GetOrderStatusList - zwraca listę dostępnych statusów zamówień,
• OrderProductSetType - typ danych dla metody GetOrderProductList,
• SetOrderPaymentStatus - ustawia status płatności dla zamówienia,
• UpdateOrder - aktualizacja zamówienia,
• UpdateOrderStatus - aktualizacja status zamówienia w zamówieniu,
• UpdateOrderDeliveryNumber - aktualizacja numeru przesyłki w zamówieniu,

Adres zamówień

http://www.shop.example.com/backend.php/order/soap?wsdl

Bony zakupowe

• AddGiftCard - dodaje nowy bon zakupowy
• CountGiftCard - podaje łączną ilość bonów zakupowych,
• DeleteGiftCard - usuwa bon zakupowy,
• GetGiftCard - pobiera informacje o bonie zakupowym,
• GetGiftCardList - pobiera listę bonów zakupowych,
• UpdateGiftCard - aktualizuje informacje o bonie zakupowym.

Adres bonów zakupowych

http://www.shop.example.com/backend.php/giftcard/soap?wsdl

Kody rabatowe

• AddDiscountCouponCode - dodaje nowy kod rabatowy,
• CountDiscountCouponCode - podaje łączną ilość kodów rabatowych,
• DeleteDiscountCouponCode - usuwa kod rabatowy,
• GetDiscountCouponCode - pobiera informacje o kodzie rabatowym,
• GetDiscountCouponCodeList - pobiera listę kodów rabatowych,
• UpdateDiscountCouponCode - aktualizuje informacje o kodzie rabatowym.

Adres kodów rabatowych

http://www.shop.example.com/backend.php/discount/soap?wsdl

Typy płatności (stPaymentType)

• GetPaymentType - zwraca Typ płatności o podanym identyfikatorze,
• GetPaymentTypeList - Zwraca listę typów płatności,
• CountPaymentType - zwraca liczbę typów płatności w sklepie.,

Adres typów płatności

http://www.shop.example.com/backend.php/payment-type/soap?wsdl

Waluty (stCurrency)

• GetCurrency - pobiera walutę,
• GetCurrencyByShortcut - pobiera walutę po kodzie ISO 4217,
• GetCurrencyList - pobiera listę walut,
• UpdateCurrencyExchange - aktualizuje kurs waluty,
• UpdateCurrencyExchangeByShortcut - aktualizuje kurs waluty po kodzie ISO 4217,
• CountCurrency - pobiera ilość walut ,

Adres walut

http://www.shop.example.com/backend.php/currency/soap?wsdl