OneCatalog API
Әзірлеушілерге арналған OneCatalog ашық API құжаттамасы. Мұнда екі API жинақталған:
| API | Мақсаты | Құжаттамадағы көлемі |
|---|---|---|
| Wiki API | Тауарлар, брендтер, санаттар, топтамалар, елдер, өлшем бірліктері, сипаттамалар және тауар түрлерінің анықтамалығы. | Толық — барлық әдістер. |
| B2B API | Жеткізушілер мен сатушыларға арналған B2B платформасы. | Тек ашық «Кілт бойынша бағалар мен қалдықтар» әдісі (share-products/{url_key}). Қалған әдістер авторизацияланған серіктестерге қолжетімді және бұл құжаттамаға кірмейді. |
Негізгі мекенжайлар
| API | Base URL |
|---|---|
| Wiki | https://api.onecatalog.net/wiki |
| B2B | https://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 бөлімдерінде әр әдіс параметрлерімен, жауап схемаларымен және сұрау мысалдарымен берілген. Әр әдісті құжаттамадан тікелей жіберуге болады.