CommonAPIgetCatalogsList » История » Редакция 13
Редакция 12 (Артем, 28.07.2017 10:12) → Редакция 13/14 (Артем, 28.07.2017 10:15)
h1. getCatalogsList h2. Описание метода --- p(. Метод возвращает список всех подключенных каталогов. Возвращаемые данные могут быть как в формате json, так и оформленны в теги html. --- h2. Параметры вызова p(. |=.параметр|=.обязательный|=.описание|возможные значения|значение по умолчанию| |*clientId*|=.-|ID клиента||Если параметр clientId не задан, то метод вернет все возможные каталоги| |*format*|=.-|формат возвращаемых данных|html или json|html| |*language*|=.-|Язык|ru или en|ru| |*domainName*|=.-|Домен каталогов (см.[[IlcatsUseOunDomain|Использование собственного домена]])| каталогов| | | |*buttonType*|=.-|Тип кнопки|defaultWithShadow или defaultWithoutShadow|defaultWithoutShadow| |*splitByRegion*|=.-|Разделять ли данные по регионам|on или off|on| |*isNeedLocaleName*|=.-|Нужно ли отображать локализованное название бренда|on или off|off| |*isNeedLocaleNameWrap*|=.-|Нужно ли <BR> перед локализованным названием бренда|on или off|off| |*isNeedOwnClasses*|=.-|Нужно ли задавать отдельные классы для html-тегов|on или off|off| Последние 4 параметра (splitByRegion, isNeedLocaleName, isNeedLocaleNameWrap, isNeedOwnClasses); действуют только тогда, когда запрашиваются данные в формате html h2. Возвращаемые данные --- Возвращает список ссылок на каталоги. h2. Получение данных в виде html: Пример вызова: http://commonapi.ilcats.ru/getCatalogsList/?splitByRegion=on&format=html&language=ru&isNeedLocaleName=on&isNeedLocaleNameWrap=on&buttonType=defaultWithShadow&clientId= Пример php-кода страницы, запрашивающей данные в формате html: <pre><code class="php"> <? header("Content-type: text/html; charset=utf-8"); ?> <html> <head> <link rel="stylesheet" href="ilcats.css"> </head> <body> <span class='ilcatsCss'> <?php $st = file_get_contents("http://commonapi.ilcats.ru/getCatalogsList/?splitByRegion=on&format=html&language=ru&isNeedLocaleName=on&isNeedLocaleNameWrap=on&buttonType=defaultWithShadow&clientId="); echo $st; ?> </span> </body> </html> </code></pre> Соответствующий файл таблицы каскадных стилей: <pre><code class="css"> .divButtonIlcatsCatalog { text-align: center; float: left; font-size: 12px; text-decorations: none; width: 130px; } .divButtonIlcatsCatalog a:link, a:visited { text-align: center; float: left; font-size: 12px; text-decoration: none; color: green; font-weight: bold; } .divRegionIlcatsCatalog { float: left; width: 100%; margin: 0px 0px 50px 0px; } .divRegionIlcatsCatalog H2 { color: #585f69; margin-top: 5px; text-shadow: none; font-weight: normal; font-family: 'Open Sans', sans-serif; font-size: 24px; line-height: 33px; } </pre> h2. Получение данных в формате json Пример запроса: http://commonapi.ilcats.ru/getCatalogsList/?splitByRegion=on&format=json&language=ru h2. Возвращаемые данные Метод возвращает объект/массив *data*, содержимое которого зависит от параметра *splitByRegion* 1. Если параметр *splitByRegion* отличается от *on* или не задан, то массив data состоит из массива *catalogs*, каждый элемент которого содержит поля: |*id*|ID каталога в нашей системе| |*url*|Ссылка на каталог| |*imageUrl*|Ссылка на логотип каталога| |*nameEng*|Название каталога на английском языке| |*nameLoc*|Название каталога в запрашиваемой локали| |*regionNameEn*|Название региона(или типа для мото/квадро и т.п.) каталога на английском языке| |*regionNameLoc*|Название региона(или типа для мото/квадро и т.п.) каталога в запрашиваемой локали| 2. Если параметр *splitByRegion* равен *on*, то массив data состоит из массива *regions*, каждый элемент которого содержит поля: |*regionNameEn*|Название региона(или типа для мото/квадро и т.п.) каталога на английском языке| |*regionNameLoc*|Название региона(или типа для мото/квадро и т.п.) каталога в запрашиваемой локали| |*catalogs*|Массив, содержащий объекты, аналогичные п.1, но без regionNameEn и regionNameLoc|