Обзор API

API KBPublisher разработан с возможностью интеграции базы знаний с другими приложениями. Это могут быть настольные, веб-ориентированные приложения, бэк-офис или для широкого круга пользователей.

Дизайн API

API KBPublisher представляет собой API, основанный на HTTP. Это означает, что все взаимодействия происходят в соответствии со стандартом HTTP. Например, GET-запросы используются для извлечения информации, POST-запросы ‒ для предоставления информации.

API поддерживает два разных типа возвращаемых значений: XML или JSON. В зависимости от того, через какое клиентское приложение вы обращаетесь к API, один возвращаемый формат может оказаться более простым в использовании, чем другой. Например, если вы обращаетесь к API через библиотеку javascript, то проще всего использовать JSON, поскольку JSON ‒ это javascript. Для настольного приложения, использующего API, лучше всего подойдет XML, т.к. его проще анализировать и отображать. Возвращаемый тип по умолчанию ‒ JSON.

Доступ к ресурсам API

Уровень доступа и разрешенные действия зависят от ролей и привилегий, назначенных пользователю. Те же правила действуют и для веб-интерфейса KBPublisher. Например, если пользователь делает API-запрос, не имея доступ к определенным статьям в веб-интерфейсе, то в API эти статьи никогда пользователю не возвратятся.

Для аутентификации API необходимы открытые и приватные ключи. Каждый пользователь имеет свои уникальные ключи.