База знаний

Получение статей

ID статьи: 382
Последнее обновление: 8 февр., 2021

Все перечисленные URL-адреса API должны иметь префикс корневого URL-адреса API.
Примеры: http://domain.com/kb/ или https://kb.domain.com/

Получение статьи

GET api.php?call=articles&id=[id]

Параметры:

  • skip_hit (опционально) – включение/отключение функции подсчета количества просмотров. Если аргумент не задан, то по умолчанию устанавливается значение 0.
  • img_rpath (опционально) – установить относительный путь для изображений в теле статьи вместо абсолютного пути. Если аргумент не задан, то по умолчанию устанавливается значение 0.

Получение списка статей

GET api.php?call=articles

Параметры: 

  • cid ‒ идентификатор категории (категория). При задании параметра возвращаются только статьи, опубликованные в категории. Параметр не обязателен.
  • method ‒ указывает метод. Если задан, то параметры sort и page игнорируются. Параметр не обязателен. Допустимые значения: 
     ‒ recent (возвращаются недавно обновленные статьи);
     ‒ popular (возвращаются наиболее просматриваемые статьи);
     ‒ featured (возвращаются избранные статьи).
  • limit ‒ количество статей, отображаемых на странице. Параметр не обязателен. Если не задан, то по умолчанию устанавливается значение 10. Максимально допустимое значение ‒ 100.
  • page ‒ количество страниц с найденными результатами для возврата. Параметр не обязателен. Если не задан, то по умолчанию устанавливается значение 1.
  • sort ‒ определяет способ сортировки результатов. Параметр не обязателен. Если не задан, то по умолчанию устанавливается значение date-updated-desc.
    Допустимые значения: title-asc, title-desc, order-asc, order-desc, date-posted-asc, date-posted-desc, date-updated-asc, date-updated-desc, hits-asc, hits-desc, rating-asc, rating-desc.
Эта статья была:   Полезна | Не полезна
ID статьи: 382
Последнее обновление: 8 февр., 2021
Ревизия: 23
Доступ: Открытый доступ
Просмотры: 5760
Комментарии: 0