3 lutego 2018

Odświeżyliśmy, uporządkowaliśmy i połączyliśmy dokumentację bramek API i Ajax oraz dodaliśmy wyszukiwarkę bramek, metod ich parametrów

Społeczność developerów jest dla nas szczególnie bliska. Dlatego stale rozwijamy mechanizmy pozwalające na customizację i poprawiamy dokumentacje, dodajemy poradniki itp. W tym miesiącu, wydaliśmy zupełnie nową stronę dokumentacji naszych API. Tym razem wszystkie API zyskały nowy, jednolity wygląd zapewniający developerom usprawnioną nawigację pozwalającą na szybkie przełączanie się między dostępnymi dokumentacjami API oraz ich metodami i atrybutami oraz wyszukiwanie. Dodaliśmy m.in. zupełnie nową, tym razem pełną dokumentację do tzw. bramek AJAX, czyli specjalnych adresów dzięki którym webmasterzy tworzący template strony samodzielnie lub modyfikując przez Dodatki HTML i JavaScript. Same bramki zostały też mocno uporządkowane tak aby zwiększyć czytelność którymi bramkami i metodami powinieneś wykonywać okreśłone operacje w panelu administracyjnym.

Developerzy mogą również skorzystać z całkowicie nowej wyszukiwarki dynamicznie zwracającej podpowiedzi dla wyszukiwanych fraz, której wyniki dopasowywane są na podstawie bramek, metod oraz ich atrybutów:

Wyszukiwarka bramek, metod oraz ich atrybutów w dokumentacjach API chmury IAI-Shop.com

Uporządkowana lista bramek dokumentacji API Panelu administracyjnego

W 61 wersji API udało nam się również przeprowadzić duże porządkowe zmiany w liście bramek dostępnych w dokumentacji panelu administracyjnego i zredukować ich ilość o 23%.

Usunięte zostały następujące bramki:

  • AddOrders / GetOrders / SetOrders, których funkcjonalność zapewniają metody #get, #insert i #update w bramce Orders
  • GetCategories / SetCategories, których funkcjonalność zapewniają metody #get i #update w nowej bramce Products Categories
  • Get Currencies, której funkcjonalność zapewnia metoda #get w bramce Currencies,
  • GetIDBySizecode, której funkcjonalność zapewnia metoda #geIds w bramce Products,
  • GetProducers, której funkcjonalność zapewnia metoda #get w nowej bramce Products Producers,
  • GetProducts / SetProducts, których funkcjonalność zapewniają metody #get i #update w bramce Products,
  • GetSeries, której funkcjonalność zapewnia metoda #get w nowej bramce Products Series,
  • GetSizes / SetSizes, których funkcjonalność zapewniają metody #get i #insert w nowej bramce Products Sizes,
  • GetTraits nie posiada swojego odpowiednika w nowej odsłonie,
  • GetUsers, której funkcjonalność zapewnia metoda #get w nowej bramce Users,
  • GetShopsData / GetServerTime, których funkcjonalność zapewniają metody #get i #getServerTime w nowej bramce System Config.

Dodane zostały następujące bramki:

  • ClientsTags - umożliwiająca zarządzanie tagami klientów,
  • Products Categories, Products Producers, Products Series, Products Sizes, Users oraz System Config, które przejęły funkcjonalność usuniętych bramek.