Проект

Общее

Профиль

Редактировать История

Wiki » Общедоступный API »

CommonAPIgetCatalogsList » История » Версия 11

Артем, 04.05.2017 15:58

1 1 Артем 
h1. getCatalogsList
2 





3








4



h2. Описание метода





5








6



---





7








8



p(. Метод возвращает список всех подключенных каталогов. Возвращаемые данные могут быть как в формате json, так и оформленны в теги html.





9








10



---





11








12



h2. Параметры вызова





13








14



p(. 





15



|=.параметр|=.обязательный|=.описание|возможные значения|значение по умолчанию|





16
2
Артем

|*clientId*|=.-|ID клиента||Если параметр clientId не задан, то метод вернет все возможные каталоги|





17
1
Артем

|*format*|=.-|формат возвращаемых данных|html или json|html|





18



|*language*|=.-|Язык|ru или en|ru|





19
8
Артем

|*buttonType*|=.-|Тип кнопки|defaultWithShadow или defaultWithoutShadow|defaultWithoutShadow|





20



|*splitByRegion*|=.-|Разделять ли данные по регионам|on или off|on|





21
1
Артем

|*isNeedLocaleName*|=.-|Нужно ли отображать локализованное название бренда|on или off|off|





22



|*isNeedLocaleNameWrap*|=.-|Нужно ли <BR> перед локализованным названием бренда|on или off|off|





23
9
Артем

|*isNeedOwnClasses*|=.-|Нужно ли задавать отдельные классы для html-тегов|on или off|off|





24
1
Артем






25
8
Артем

Последние 4 параметра (splitByRegion, isNeedLocaleName, isNeedLocaleNameWrap, isNeedOwnClasses); действуют только тогда, когда запрашиваются данные в формате html





26
1
Артем






27








28



h2. Возвращаемые данные





29








30



---





31








32



Возвращает список ссылок на каталоги.





33








34
8
Артем

h2. Получение данных в виде html:





35
1
Артем






36
8
Артем

Пример вызова: http://commonapi.ilcats.ru/getCatalogsList/?splitByRegion=on&format=html&language=ru&isNeedLocaleName=on&isNeedLocaleNameWrap=on&buttonType=defaultWithShadow&clientId= 





37








38



Пример php-кода страницы, запрашивающей данные в формате html:





39








40
2
Артем

<pre><code class="php">





41
6
Артем

<?





42
4
Артем

header("Content-type: text/html; charset=utf-8");





43



?>





44



<html>





45



<head>





46



  <link rel="stylesheet" href="ilcats.css">





47



</head>





48








49



<body>





50



<span class='ilcatsCss'>





51



<?php





52








53
7
Артем

$st = file_get_contents("http://commonapi.ilcats.ru/getCatalogsList/?splitByRegion=on&format=html&language=ru&isNeedLocaleName=on&isNeedLocaleNameWrap=on&buttonType=defaultWithShadow&clientId=");





54
4
Артем

echo $st;





55








56



?>





57



</span>





58
1
Артем

</body>





59








60



</html>





61



</code></pre>





62
5
Артем






63



Соответствующий файл таблицы каскадных стилей:





64



<pre><code class="css">





65



.divButtonIlcatsCatalog {





66



	text-align: center;





67



	float: left;





68



	font-size: 12px;





69



	text-decorations: none;





70



	width: 130px;





71



}





72
6
Артем

.divButtonIlcatsCatalog a:link, a:visited {





73
5
Артем

	text-align: center;





74



	float: left;





75



	font-size: 12px;





76



	text-decoration: none;





77



	color: green;





78



	font-weight: bold;





79



}





80








81



.divRegionIlcatsCatalog {





82



	float: left;





83



    width: 100%;





84



    margin: 0px 0px 50px 0px;





85



}





86
6
Артем

.divRegionIlcatsCatalog H2 {





87
5
Артем

	color: #585f69;





88



    margin-top: 5px;





89



    text-shadow: none;





90



    font-weight: normal;





91



    font-family: 'Open Sans', sans-serif;





92
1
Артем

    font-size: 24px;





93



    line-height: 33px;





94



}





95



</pre>





96
8
Артем






97








98



h2. Получение данных в формате json





99








100



Пример запроса: http://commonapi.ilcats.ru/getCatalogsList/?splitByRegion=on&format=json&language=ru





101
10
Артем






102



h2. Возвращаемые данные





103








104
11
Артем

Метод возвращает объект/массив *data*, содержимое которого зависит от параметра *splitByRegion*





105
10
Артем






106



1. Если параметр *splitByRegion* отличается от *on* или не задан, то массив data состоит из массива *catalogs*, каждый элемент которого содержит поля:





107








108



|*id*|ID каталога в нашей системе|





109



|*url*|Ссылка на каталог|





110



|*imageUrl*|Ссылка на логотип каталога|





111



|*nameEng*|Название каталога на английском языке|





112



|*nameLoc*|Название каталога в запрашиваемой локали|





113



|*regionNameEn*|Название региона(или типа для мото/квадро и т.п.) каталога на английском языке|





114



|*regionNameLoc*|Название региона(или типа для мото/квадро и т.п.) каталога в запрашиваемой локали|





115








116








117



2. Если параметр *splitByRegion* равен *on*, то массив data состоит из массива *regions*, каждый элемент которого содержит поля:





118








119



|*regionNameEn*|Название региона(или типа для мото/квадро и т.п.) каталога на английском языке|





120



|*regionNameLoc*|Название региона(или типа для мото/квадро и т.п.) каталога в запрашиваемой локали|





121



|*catalogs*|Массив, содержащий объекты, аналогичные п.1, но без regionNameEn и regionNameLoc|