API: URL-адрес, методы, форматы ответа, аутентификация

Как включить API

Для включения API войдите в Панель администратора и перейдите Настройки ‒> Администрирование ‒> API. В поле Разрешить API доступ установите флаг.
Чтобы настроить API для приема запросов только с использованием протокола SSL с помощью HTTPS, установите флаг Безопасное API соединение.
SSL шифрует передачу, которая защищает ваш запрос и ответ от просмотра при пересылке.

URL-адрес API

Доступ к API осуществляется с URL-адреса, по которому установлен ваш KBPublisher:
http://[your_domain]/[kb_dir]/api.php
где
[your_domain] ‒ имя вашего домена;
[kb_dir] ‒ папка установки KBPublisher.

Пример: http://www.domain.com/kb/api.php

Аутентификация API

API базы знаний требует, чтобы вы аутентифицировали каждый запрос, подписывая его.
Процесс описан в этой статье.

Версия API

KBPublisher версии 7.0 поддерживает API версии 1 и 2. По умолчанию и если не задано, API использует версию 1. Чтобы указать версию API, которую хотите использовать, добавьте значение для строкового параметра "version" в URL-адресе своего API.

Пример: /api.php?call=articles&version=2

Формат ответа

В настоящее время поддерживаются два формата ответа:

• JSON (по умолчанию)
• XML.

Вы можете указать тип ответа, добавив строковый параметр "format" к URL-адресу API. Если необходимо получить JSON, указывать формат вывода не нужно, поскольку это значение установлено по умолчанию.
Пример: /api.php?call=articles&format=xml

Ограничение полученных полей

По умолчанию все доступные поля возвращаются при выполнении запроса. Вы можете выбрать поля, которые хотите получить, указав параметр запроса "fields". Это существенно повышает эффективность и быстродействие вызовов API.
Пример: /api.php?call=news&fields=id,title,datePosted

Пример

Пример на PHP:
request.php.zip