Struktura formatu IOF w XML

Dzięki przejrzystej strukturze IOF jest łatwy do zaimplementowania w dowolnym systemie. Format ma charakter otwarty i jest udostępniony za darmo na prawach Creative Commons.

Najnowszą rekomendowaną przez nas wersją jest wersja IOF 3.0, poniższy obrazek przedstawia strukturę jej formatu:

Głównym i obowiązkowym plikiem struktury jest plik gateway.xml stanowi on zbiór podstawowych informacji o dostawcy oraz linków do podstawowych (full.xml, light.xml), opcjonalnych różnicowych (full_change.xml) oraz referencyjnych plików oferty (categories.xml, sizes.xml, producers.xml, units.xml, parameters.xml, stocks.xml, series.xml, warranties.xml, preset.xml). Dostarcza odbiorcy informacji o dacie wygenerowania i wygaśnięcia jego oferty, a poprzez zwracanie sumy kontrolnej (atrybut @hash) oraz daty ostatniej modyfikacji (atrybut @changed) w węzłach poszczególnych jej plików pozwala na ich pobierania, tylko gdy faktycznie zajdzie taka potrzeba.

Czy wiesz, że:

Zwielokrotnisz oszczędność wykorzystanego transferu i mocy obliczeniowej swojego serwera, gdy zadbasz o to, aby tworzony program integrujący miał możliwość wykorzystania sum kontrolnych oraz prawidłowo obsługiwał faktyczne daty ostatniej modyfikacji poszczególnych plików formatu IOF i daty ważności głównego pliku gateway.xml.

Pierwszym podstawowym plikiem oferty jest plik full.xml zawierający podstawowe informacje o towarach np. opisy, zdjęcia, atrybuty, załączniki czy grupy towarów bądź składowe zestawów i kolekcji. Część dostępnych w nim informacji jest celowo powielana z plikami referencyjnymi, aby każdy developer mógł wykorzystać je w dogodny dla siebie sposób. Ze względu na jego wielkość w całości plik może być rzadziej generowany (np. raz na dobę), a wówczas zachodzące w nim w ciągu dnia zmiany mogą być generowane częściej (np. raz na godzinę) w postaci opcjonalnych dla niego plików różnicowych full_changeYYYY-MM-DDThh-mm-ss.xml (gdzie YYYY-MM-DDThh-mm-ss winien wskazywać datę i godzinę ostatniej zmiany).

Czy wiesz, że:

Udostępniając możliwość pobierania plików różnicowych (full_change.xml), ograniczysz ilość generowanego na serwerze ruchu oraz zapewnisz swoim odbiorcom szybszą synchronizację i aktualizację informacji o oferowanych im towarach.

Drugim podstawowym plikiem oferty jest plik light.xml zawierający informacje m.in. o rozmiarach, ich lokalizacji na magazynie i stanach dyspozycyjnych, kodach producenta, wagach oraz cenach uwzględniających rabaty i walutę indywidualnego odbiorcy, który musi być zarejestrowany jako klient danego sklepu. Dlatego też plik ten generowany na żądanie, przy każdym pobraniu.

Czy wiesz, że:

Wykorzystując plik light.xml w połączeniu z narzędziem webowego import, aktualizacji i przywracanie towarów z kopii zapasowej lub aplikacją pomocnicza Downloader ustawisz szybką aktualizację stanów magazynowych synchronizowanych towarów oraz ich cen sprzedaży bez konieczności pobierania pozostałych plików oferty.

Pliki categories.xml, producers.xml, series.xml, warranties.xml, parameters.xml, units.xml oraz sizes.xml i stocks.xml są plikami referencyjnymi stanowiącymi zbiory wszystkich kategorii, producentów, serii, gwarancji, parametrów, jednostek miar oraz rozmiarów i magazynów wraz z ich wielojęzycznymi tłumaczeniami. Są ściśle powiązane z podstawowymi plikami oferty.

Elementy obsługiwane przez funkcję wielojęzyczności:

nazwa produktu,
krótki opis produktu,
długi opis produktu,
nazwa kategorii,
nazwa rozmiaru,
nazwa jednostki miary,
nazwa, opis i grafika parametrów,
nazwa serii,
nazwa i opis gwarancji,
nazwa załącznika,
nazwa magazynu.

Ostatnim plikiem oferty jest plik preset.xml przechowujący informacje na temat konfiguracji oferty na potrzeby programu służącego do jej synchronizacji (np. Downloader.). Sposób tworzenia pliku oraz jego wykorzystania został opisany na stronie eksport i import ustawień dostawcy z pliku w aplikacji Downloader.

Struktura formatu nadaje się zarówno do zapisu małej oferty, jak i tych wielkich i szczegółowych, dla których można:

tworzyć opisy towarów w dowolnych językach,
tworzyć zestawy i kolekcje wraz z ich składowymi,
podawać ceny w dowolnej walucie,
określać kody producenta dla rozmiarów w wybranym standardzie,
określać stan ilościowy w konkretnym magazynie,
określać typy gwarancji,
dodawać ikony i zdjęcia w dowolnej ilości,
dodawać załączniki do towarów w formie plików wideo, audio, pdf, zip, doc itp.,
definiować nazwy atrybutów towarów tj. kategorie, rozmiary, gwarancje, serie w różnych językach,
ustawiać ceny przekreślone lub sugerowane, które potem są wyświetlane kupującemu w sklepie.

Standardy

W plikach oferty zastosowane zostały następujące standardy i reguły:

waluta (currency) według ISO 4217 - np. PLN, USD, EUR,
język (language) według ISO 639-2 - np. pol, eng, deu=ger,
data i czas wygenerowania oferty (generated), wygaśnięcia oferty (expires) oraz ostatniej zmiany (changed) według ISO 8601 - np. 2016-05-25T11:08:51+01:00,
niedozwolone jest wpisywanie tych samych danych do znaczników @id, @code i @code_producent,
każdy plik musi zawierać atrybuty wersji i formatu (umieszczone wewnątrz głównego znacznika).

Struktura formatu IOF w XML

Standardy

Pliki dokumentacji z przykładowymi plikami XML i walidatorami XSD