Struktura danych
Deante udostępnia klientom dostęp do API, które pozwala na pobranie danych w formie dwóch typów plików:
JSON
Najnowszym sposobem w jaki API przekazuje informacje są dane zapisane w pliku o formacie JSON. Pod wieloma względami jest bardzo podobny do XML, będąc plikiem tekstowym przechowującym dane ustrukturyzowane w formie 'drzewa'. Ma on natomiast czytelniejszą formę, jako że wszelkie obiekty, nazywane w XML tagami, w formacie JSON zdefiniowane są w następujący sposób:
Przykładowy układ pliku JSON
"Product": { "id": "XXX_XXXX", "name": "XXX", "prices": { "currency": "PLN", "netPrice": "00.00", "hasPromotion": false }}Obiekt w notacji JSON określany jest najpierw poprzez nazwę, a następnie przez znak ": {", oznaczający rozpoczęcie zakresu danych, które opisywać będą dany obiekt. Znak } określa koniec obiektu. Jak widać bardzo prosto jest dodać kolejny poziom zagłębienia, wystarczy, aby przy wartości podelementu ponownie otworzyć nawiasy klamrowe.
Deante udostępnia możliwość pobrania dwóch plików JSON, jeden zawierający pełny katalog produktów, ze wszystkimi dostępnymi w standardzie JSON informacjami, natomiast drugi posiadający jedynie informacje o stanach magazynowych.
W celu poznania struktury pliku produktowego JSON Deante przejdź tutaj, natomiast informacje o strukturze pliku JSON ze stanami magazynowymi znajdują się tutaj.
XML
Standard XML posiada mniej informacji, niż standard JSON!
Ze względu na integralność pliku i zabezpieczenie systemów klientów już korzystających z API XML, plik pozostaje w niezmienionej formie i nie może zostać rozszerzony. Zachęcamy do skorzystania z API JSON, który posiada więcej danych produktowych
Pierwotny format wymiany danych Deante. XML (Extensible Markup Language) służy do ustrukturyzowanego przechowywania danych w formie tekstowej. Na stworzenie struktury pozwalają tak zwane tagi, które w XML oznaczane są pomiędzy znakami < >, a ich koniec oznacza się symbolem </ >. Przykład: <PRODUCTS> <\PRODUCTS>
Tagi mogą mieć przypisane tak zwane atrybuty, czyli dodatkowe informacje w formie tekstowej mające sprecyzować zastosowanie tagu. Dobrym sposobem na zaprezentowanie zalet atrybutów może być przykład z API Deante, dla pola <PRICE_NETTO>. W API prezentuje się ono następująco:
<PRICE_NETTO currency="PLN">14.87</PRICE_NETTO>Tag <PRICE_NETTO> zawiera w sobie jedynie informację o cenie, natomiast waluta w jakiej cena jest podana zdefiniowana jest w atrybucie currency. Podobny efekt bez wykorzystania atrybutu można by było uzyskać poprzez następującą strukturę pola <PRICE_NETTO>:
<PRICE_NETTO> <value>14.87</value> <currency>PLN</currency></PRICE_NETTO>Jak widać jest to mniej praktyczne rozwiązanie, jako że <PRICE_NETTO> musi teraz posiadać dwa zagnieżdzone w sobie pola, jedno dla waluty, drugie dla faktycznej ceny.
Deante udostępnia możliwość pobrania dwóch plików XML, jeden zawierający pełny katalog produktów, ze wszystkimi dostępnymi w standardzie XML informacjami, natomiast drugi posiadający jedynie informacje o stanach magazynowych. W celu poznania struktury pliku produktowego XML Deante przejdź tutaj, natomiast informacje o strukturze pliku XML ze stanami magazynowymi znajdują się tutaj.