WebAPI Informacje podstawowe - Interfejs

Sklep udostępnia API dla zewnętrznych aplikacji, za pośrednictwem kilku protokołów. Ze względu na wydajność i ilość przesyłanych danych, najbardziej preferowanym jest interfejs JSON.

---

1. JSON

Aby skorzystać z tego interfejsu, należy przesłać dane wejściowe w postaci tabeli z parametrami POST w zmiennej o 'json', pod następujący adres:

http://-adres-sklepu-/ext/webapi/json

Tabela musi być przekazana w postaci zakodowanej według standardu JSON i ma mieć następującą postać:

array (
"method" => FFF,
"params" => array (
XXX_1 => YYY_1,
XXX_2 => YYY_2,
...
)
)

gdzie:
FFF - nazwa wywoływanej funkcji
XXX - nazwa parametru
YYY - wartość parametru

Przykładowe wywołanie:

array (
"method" => "doGetProductInfo",
"params" => array (
"product_id"=>187
)
)

Dane przesyłane poprzez interfejs:

json = {"method":"doGetProductInfo","params":{"product_id":187}}

Wynikiem działania jest tabela zakodowana w standardzie JSON, zawierająca wynik wywoływanej funkcji według dokumentacji.

---

2. XML

Aby skorzystać z tego interfejsu, należy przesłać dane wejściowe w postaci XML, przesłanego metodą POST w zmiennej 'xml', pod następujący adres:

http://-adres-sklepu-/ext/webapi/xml

Dane muszą być przekazana w postaci XML i mają mieć następującą postać:

<?xml version="1.0" encoding="UTF-8"?>
<data>
<method>FFF</method>
<params>
<XXX_1>YYY_1</XXX_1>
<XXX_2>YYY_2</XXX_2>
...
</params>
</data>

gdzie:
FFF - nazwa wywoływanej funkcji
XXX - nazwa parametru
YYY - wartość parametru

W razie, gdyby wartości parametrów mogły zawierać znaki niedozwolone w plikach XML, można zawrzeć ją wewnątrz znaczników
<![CDATA[ ... ]]>

Przykładowe wywołanie:

<?xml version="1.0" encoding="UTF-8"?>
<data>
<method>doGetProductInfo</method>
<params>
<product_id>278</product_id>
</params>
</data>

Dane przesyłane poprzez interfejs:

Wynikiem działania jest plik XML, zawierający wynik wywoływanej funkcji według dokumentacji.

---

3. SOAP

Interfejs jest dostępny pod adresem:

http://-adres-sklepu-/ext/webapi/wsdl

Dokument WSDL jest również dostępny pod tym adresem. Warunkiem jego uzyskania jest wywołanie typu GET.