Все URL-адреса API, приведенные ниже, должны иметь префикс корневого URL-адреса API.
Пример: http://domain.com/kb/ или https://kb.domain.com/
Поиск по всему содержимому
GET api.php?call=search
Аргументы:
- q (необязателен) ‒ свободный текстовый поиск. Поисковый запрос с UTF-8 или URL-кодированием и максимальным количеством символов (1000), включая операторы.
- in (необязателен) ‒ определяет, в каком контенте следует искать. Если аргумент опущен, то по умолчанию используется весь контент.
Допустимые значения:
- all (весь контент);
- article (поиск в статьях);
- file (поиск в файлах);
- news (поиск в новостях).
- by (необязателен) ‒ определяет, где искать результаты. Если аргумент опущен, то по умолчанию поиск выполняется везде.
Допустимые значения:
- all (везде ‒ заголовок, содержание статьи, ключевые слова/теги);
- title (поиск только в заголовках);
- keyword (поиск только в ключевых словах/тегах);
- id (поиск по идентификатору записи).
- min_date (необязателен) ‒ минимальная дата обновления. Возвратятся статьи с датой обновления, которая больше или равна указанному значению. Дату можно задавать в виде unix timestamp или mysql datetime.
- max_date (необязателен) ‒ максимальная дата обновления. Возвратятся статьи с датой обновления, которая меньше или равна указанному значению. Дату можно задавать в виде unix timestamp или mysql datetime.
- posted (необязателен) ‒ режим даты. Указанная дата публикации будет использована вместо даты обновления, заданная в двух параметрах выше (min_date и max_date).
- limit (необязателен) ‒ количество статей, отображаемых на странице. Если аргумент опущен, то по умолчанию устанавливается значение 10. Максимально допустимое значение ‒ 100.
- page (необязателен) ‒ количество страниц с найденными результатами для возврата. Если аргумент опущен, то по умолчанию устанавливается значение 1.
- skip_log (необязателен) ‒ включает/отключает регистрацию запроса. Если аргумент опущен, то по умолчанию устанавливается значение 0.
Поиск только статей
Вы можете сузить поиск, задав аргумент in.
GET api.php?call=search&in=article
Аргументы:
- Все аргументы, перечисленные в секции Search all content +
- cid (необязателен) ‒ идентификатор категории (категория) для поиска. При задании параметра возвращаются только статьи, опубликованные в этой категории.
- child (необязателен) ‒ включает/отключает поиск в дочерних категориях. Если включено, то возвращаются статьи, опубликованные в категории (cid) и во всех дочерних категориях. По умолчанию установлено значение 1.
- custom (необязателен) ‒ включает/отключает поиск в произвольных полях. Если включено, то возвращаются только статьи, соответствующие значениям, указанным в произвольных полях. Идентификаторы полей можно найти в списке произвольных полей KBPublisher.
Синтаксис:
- custom[custom_field_id]=custom_value
- custom[custom_field_id]=custom_value_id
Пример:
- custom[5]=text
- custom[1]=2
- custom[4]=2,2
Поиск только файлов
Вы можете сузить поиск, задав аргумент in.
GET api.php?call=search&in=file
Аргументы:
- Все аргументы, перечисленные в секции Search all content +
- cid (необязателен) ‒ идентификатор категории (категория) для поиска. При задании параметра возвращаются только файлы, опубликованные в этой категории.
- child (необязателен) ‒ включает/отключает поиск в дочерних категориях. Если включено, то возвращаются файлы, опубликованные в категории (cid) и во всех дочерних категориях. По умолчанию установлено значение 1.
- custom (необязателен) ‒ включает/отключает поиск в произвольных полях. Если включено, то возвращаются только файлы, соответствующие значениям, указанным в произвольных полях. Идентификаторы полей можно найти в списке произвольных полей KBPublisher.
Синтаксис:
- custom[custom_field_id]=custom_value
- custom[custom_field_id]=custom_value_id
Пример:
- custom[5]=text
- custom[1]=2
- custom[4]=2,2
Поиск только новостей
Вы можете сузить поиск, задав аргумент in.
GET api.php?call=search&in=news
Аргументы:
- Все аргументы, перечисленные в секции Search all content +
- custom (необязателен) ‒ включает/отключает поиск в произвольных полях. Если включено, то возвращаются только новости, соответствующие значениям, указанным в произвольных полях. Идентификаторы полей можно найти в списке произвольных полей KBPublisher.
Синтаксис:
- custom[custom_field_id]=custom_value
- custom[custom_field_id]=custom_value_id
Пример:
- custom[5]=text
- custom[1]=2
- custom[4]=2,2
