Взаимодействие с серверной частью Удаленного помощника по REST API

Для активации возможности взаимодействия клиентской части с серверной частью Удаленного помощника по REST API предусмотрен технологический компонент termidesk_assistant_api, представляющий собой библиотеку для Python, устанавливаемую на узел с клиентской частью.

Для установки termidesk-assistant-api в ОС Astra Linux Special Edition нужно:

открыть программу «Терминал Fly» и получить доступ к интерфейсу командной строки;
установить пакет виртуальной среды для Python python3-venv командой:

sudo apt -y install python3-venv

BASH

создать виртуальное окружение, например, my_venv, командой:

python -m venv my_venv

BASH

Для разных версий Python могут использоваться разные команды для установки виртуального окружения и его использования.

активировать виртуальное окружение my_venv командой:

source my_venv/bin/activate

BASH

установить библиотеку termidesk_assistant_api-<версия>.tar.gz:

pip install <путь_к_termidesk_assistant_api-<версия>.tar.gz>

BASH

Для установки termidesk-assistant-api в ОС Microsoft Windows нужно:

установить Python для ОС Microsoft Windows, предварительно загрузив установщик (доступ: https://www.python.org/downloads/windows/);
запустить интерфейс командной строки от имени администратора;
создать виртуальное окружение, например, my_venv, командой:

C:\Windows\system32> python -m venv my_venv

BASH

активировать виртуальное окружение my_venv командой:

C:\Windows\system32> source my_venv/bin/activate

BASH

установить библиотеку termidesk_assistant_api-<версия>.tar.gz:

C:\Windows\system32> pip install <путь_к_termidesk_assistant_api-<версия>.tar.gz>

BASH

Для начала работы с библиотекой termidesk_assistant_api нужно:

переключиться на интерпретатор Python:

python

BASH

Для ОС Microsoft Windows команда переключения будет аналогичной:

C:\Windows\system32> python

BASH

выполнить импорт установленной библиотеки:

>>> from termidesk_assistant_api import rest

BASH

Примеры запросов REST API в Python, которые могут быть использованы:

получение версии серверной части Удаленного помощника:

example = rest.Client(url="https://192.0.2.1/assistant")
print(example.version())

BASH

установка места хранения файла журнала (обязательно для ОС Microsoft Windows):

example = rest.Client(url="https://192.0.2.1/assistant")
example.init_logging("C:\\logs\\log.log")

BASH

получение JSON-структуры с информацией о серверной части:

example = rest.Client(url="https://192.0.2.1/assistant")
print(example.discovery())

BASH

получение версии Удаленного помощника и создание сессии:

example = rest.Client(url="https://192.0.2.1/assistant")
print(example.version())  # получение версии
print(example.session.create().session_id) # создание сессии и возврат ее ID

BASH

В приведенных примерах использованы следующие параметры:

192.0.2.1 - IP-адрес узла с установленной серверной частью Удаленного помощника;
C:\\logs\\log.log - путь к файлу, который будет использоваться как журнал.