Проект

Общее

Профиль

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

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

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

Артем, 28.07.2017 10:12

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
12
Артем

|*domainName*|=.-|Домен каталогов| | |





20
8
Артем

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





21



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





22
1
Артем

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





23



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





24
9
Артем

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





25
1
Артем






26
8
Артем

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





27
1
Артем






28








29



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





30








31



---





32








33



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





34








35
8
Артем

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





36
1
Артем






37
8
Артем

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





38








39



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





40








41
2
Артем

<pre><code class="php">





42
6
Артем

<?





43
4
Артем

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





44



?>





45



<html>





46



<head>





47



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





48



</head>





49








50



<body>





51



<span class='ilcatsCss'>





52



<?php





53








54
7
Артем

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





55
4
Артем

echo $st;





56








57



?>





58



</span>





59
1
Артем

</body>





60








61



</html>





62



</code></pre>





63
5
Артем






64



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





65



<pre><code class="css">





66



.divButtonIlcatsCatalog {





67



	text-align: center;





68



	float: left;





69



	font-size: 12px;





70



	text-decorations: none;





71



	width: 130px;





72



}





73
6
Артем

.divButtonIlcatsCatalog a:link, a:visited {





74
5
Артем

	text-align: center;





75



	float: left;





76



	font-size: 12px;





77



	text-decoration: none;





78



	color: green;





79



	font-weight: bold;





80



}





81








82



.divRegionIlcatsCatalog {





83



	float: left;





84



    width: 100%;





85



    margin: 0px 0px 50px 0px;





86



}





87
6
Артем

.divRegionIlcatsCatalog H2 {





88
5
Артем

	color: #585f69;





89



    margin-top: 5px;





90



    text-shadow: none;





91



    font-weight: normal;





92



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





93
1
Артем

    font-size: 24px;





94



    line-height: 33px;





95



}





96



</pre>





97
8
Артем






98








99



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





100








101



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





102
10
Артем






103



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





104








105
11
Артем

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





106
10
Артем






107



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





108








109



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





110



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





111



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





112



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





113



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





114



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





115



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





116








117








118



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





119








120



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





121



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





122



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