REST API. Начало работы с REST API компонента «Удаленный помощник»

Формат URL-команд для компонента «Удаленный помощник»

Общий вид команд реализован следующим образом:

/api/<module>,

где:

<module> - наименование модуля, реализованного в REST API.

Список модулей API, предоставляемого компонентом, может быть получен URL-командой /api/discover/.

Пример команды через curl:

curl -X 'GET' \
  'https://assistant.termidesk.local/api/discover/' \
  -H 'accept: application/json' \
  -H 'X-CSRFToken: HjXcGpVu8bSPEoq4NQ0qo0KpdfwoEbuTbElG3J7uSFr2aK3oPtNqlnw4VEARS2HY'

где:

assistant.termidesk.local - сетевой адрес или полное доменное имя узла компонента «Удаленный помощник» Termidesk;

X-CSRFToken - уникальный идентификатор запроса, генерируемый Django. Значение токена уникально и время его жизни ограничено.

Электронный справочник по командам REST API компонента «Удаленный помощник»

Полная информация о параметрах и командах REST API доступна при вводе URL-команды https://assistant.termidesk.local/assistant/api/docs/, где assistant.termidesk.local - сетевой адрес или полное доменное имя узла компонента «Удаленный помощник» Termidesk.