Доступ к REST API

REST API доступен по адресам, указанным в настройках AggreGate Server для REST API.

REST API имеет следующие параметры:

  • Время жизни токена определяет, сколько времени токен остается действительным.
  • Секретный ключ, чье название говорит само за себя. Используется для подписи токенов доступа.
  • Сгенерировать секретный ключ  - чекбокс, который активирует генерацию нового Ключа сервера.
  • Разрешенные значения Origin (для проверок CORS) - разделённый запятыми список источников (хостов, портов и схем), с которых разрешены запросы к серверу AggreGate Server. Специальное значение * означает доступность из любых источников. Выставленное здесь значение будет возвращаться сервером в заголовке Access-Control-Allow-Origin при ответах на CORS-запросы. При отсутствии значения запросы из любых сторонних источников будут запрещены.

Токены REST API становятся недействительными после перезагрузки сервера. Чтобы токены оставались действительными после перезагрузки, отключите параметр Сгенерировать секретный ключ и убедитесь, что заполнено поле Секретный ключ. С такими настройками прежние токены останутся действительными после перезагрузки, но чтобы они работали, необходимо снова залогиниться на сервере под тем же именем пользователя, для которого были получены прежние токены.

REST API работает через HTTP или HTTPS соединение и использует авторизацию. По умолчанию, можно получить доступ к REST API по следующим адресам и портам локального хоста:

  • https://localhost:8443/rest/{request} для HTTPS соединений
  • http://localhost:8080/rest/{request} для HTTP соединений

В примерах выше, замените {request} запросом, как описано в Справочнике REST API.

Чтобы получить результат такого запроса, необходимо авторизоваться.

Пример:

Если AggreGate Server работает на локальном хосте, он имеет виртуальное устройство, и все показатели настроек выставлены по умолчанию, вы можете вызвать REST API, использую следующий URL:

https://localhost:8443/rest/v1/contexts/users.admin.devices.virtual

Этот запрос получает информацию о контексте users.admin.devices.virtual, который является контекстом виртуального устройства.