Вход | Регистрация
Xevian.CMS: База знаний
Шаблоны
Терминология
Руководство разработчика
Вопросы
- Системные константы
- Системные переменные
- Локализации
- Типы статических блоков
Типы контейнеров статических блоков
- Типы параметров
- Плэйсхолдеры
- Шаблоны
CSS классы
- Паттерны


ГлавнаяВопросыВеб-инженеруРазработкаAPIAPI

API

  1. В структуре сайта источника необходимо создать раздел с путем api, подключением Search_Content и шаблоном api.html.
  2. api.html должен содержать meta charset="utf-8 и плейсхолдер DATA.
  3. Формат запроса: http://site.ru/api/?notabs&json&content_id=айди_модуля&keywords=ключевое_слово
  4. Формат ответа - массив из двух элементов - total - общее кол-во материалов и items - массив материалов:
    array('total' => 'Общее кол-во материалов', 'items' => 'Массив материалов');​​​​​​​​

Примеры запросов:

  1. Данные конкретного материала контентного модуля: http://site.ru/api/?notabs&json&content_id=n1&item_id=n2, где n1 - id контентнго модуля, n2 - id - материала.
    Как узнать эти id, см.

    ​​


     
  2. Список материлов контентного модуля http://site.ru/api/?notabs&json&content_id=n1&content_folders_id=n3&exclude_fields=n4&per_page=n5&page=n6, где  n1 - id контентнго модуля; n3 - id папки; n4 - идентификаторы полей через запятую, которые надо исключить из выдачи, напрмиер,  description,seo_title,seo_keywords,seo_description; n5 ​- количество материалов на странице, если per_page не задан, см. количестов элементов в кофигурации контентного модуля; n6 - номер страницы.

    Как узнать id папки, см.



    Как узнать количество элементов в конфигурации контентнго модуля, см.




     
  3. Сортировка списка по полю - добавьте к запросу строчку &sort=поле&direction=направление, где поле - price, date_modified, date_added, sort, viewed и т.д., направление - asc или desc.
  4. Выборка материалов по связанному контентному модулю http://site.ru/api/?notabs&json&content_id=n1&модуль=n2, где n1 - id контентного модуля, модуль - идентификатор контентного модуля, n2 - id  материала контентного модуля.
  5. Выборка материалов по справочнику - http://site.ru/api/?notabs&json&content_id=n1&справочник=n2, где n1 - id контентного модуля, справочник - идентификатор справочника, n2 - id элемента справочника.

    Как узнать id справочника и id элемента справочника, см.



Комментарии

Вы не авторизованы. При отправке сообщения, в качестве автора будет указан "Гость". Вход | Регистрация

Руководство разработчика