Skip to main content

OneCatalog API

Әзірлеушілерге арналған OneCatalog ашық API құжаттамасы. Мұнда екі API жинақталған:

APIМақсатыҚұжаттамадағы көлемі
Wiki APIТауарлар, брендтер, санаттар, топтамалар, елдер, өлшем бірліктері, сипаттамалар және тауар түрлерінің анықтамалығы.Толық — барлық әдістер.
B2B APIЖеткізушілер мен сатушыларға арналған B2B платформасы.Тек ашық «Кілт бойынша бағалар мен қалдықтар» әдісі (share-products/{url_key}). Қалған әдістер авторизацияланған серіктестерге қолжетімді және бұл құжаттамаға кірмейді.

Негізгі мекенжайлар

APIBase URL
Wikihttps://api.onecatalog.net/wiki
B2Bhttps://api.onecatalog.net/b2b

Жауаптарды локализациялау

Екі API да lang сұрау параметрі арқылы көптілді жауаптарды қолдайды. Қолжетімді мәндер:

КодТіл
ruОрысша (әдепкі)
enАғылшынша
arАрабша
zhҚытайша
kkҚазақша

Мысал:

curl "https://api.onecatalog.net/wiki/v1/products/?lang=en"

Жауаптарда нақты қолданылған тіл мен қор тілі (fallback) көрсетілген meta.i18n блогы болады.

Аутентификация

  • Wiki API — әдістердің көпшілігі ашық. Кеңейтілген өрістер үшін API кілтін api-key сұрау параметрінде немесе X-API-Key тақырыбында беріңіз.
  • B2B API (ашық share-products) — прайс-парақтың url_key мәні арқылы қолжетімді; қажет болса қосымша private_key сұрау параметрі арқылы беріледі.

Жауап форматы

Жауаптар JSON форматында қайтарылады. Көптеген Wiki әдістері response_fmt параметрін (json, yaml, yml, xml) және файлмен экспорттауды (is_download=1) қолдайды. Беттеу start және limit арқылы орындалады.

tip

Сол жақтағы Wiki API және B2B API бөлімдерінде әр әдіс параметрлерімен, жауап схемаларымен және сұрау мысалдарымен берілген. Әр әдісті құжаттамадан тікелей жіберуге болады.