Оглавление
Описание
Администратор Базы знаний (или администратор портала Битрикс24) может перейти в настройки Базы знаний и получить токен для доступа к API Базы Знаний. Токен необходим для того, чтобы использовать Rest API Базы знаний. Доступные методы:
| Метод | Обязательные параметры | Дополнительные параметры | Возвращает параметры |
|---|---|---|---|
|
article.save Позволяет создать и сохранить статью в Базе знаний |
token: str - токен для интеграции title: str - название статьи |
article_id, link_to_id external_id, body directory_id sort, tags tags_delimiter force plain_text release_lock |
result article |
|
article.get Позволяет получить всю информацию о статье |
token: str - токен для интеграции id: int - id статьи |
нет |
tags readers editors custom_access read_access edit_access public_url is_favorite is_subscribed can_edit user id user_id title public rendered_body directory_id link_to_id, external_id post_id sort froala plain_text created edited call_placement |
|
article.delete Позволяет удалить статью из базы знаний |
token: str - токен для интеграции id: int - id статьи |
force from_bin |
result |
| directory.save Позволяет создать или отредактировать директорию в базе знаний |
token: str - токен для интеграции name: str - имя директории |
id parent_id sort icon_name description for_templates required_to_read |
result created id |
|
directory.delete Позволяет удалить пустую директорию |
token: str - токен для интеграции dirs: list - список id’s директорий |
articles force |
success |
|
directory.set.access Для корректной работы после указанного метода через слеш необходимо передать ID нужной директории Позволяет установить права доступа для директории |
token: str - токен для интеграции |
read write |
result read_access edit_access |
|
event.list Позволяет получить список событий в базе знаний |
token: str - токен для интеграции |
start_id type |
events |
Как получить токен
Чтобы получить свой токен для интеграции, нужно перейти в настройки Базы Знаний (пролистать левое меню до конца) и нажать на кнопку “Создать токен для интеграции”.
Появится поле с токеном пользователя для интеграции Базы Знаний (у каждого пользователя свой токен). Токен при необходимости можно посмотреть, скопировать или обновить (создастся новый токен для интеграции, а старый перестанет действовать).