REST API

В XDR можно обращаться из сторонних решений с помощью API. XDR REST API работает по протоколу HTTP и состоит из набора методов запросов/ответов.

Справка REST API Swagger

На странице Swagger используйте раскрывающийся список Выбрать определение для переключения между наборами API KUMA и API XDR (OSMP).

Запросы REST API необходимо отправлять по следующему адресу:

https://api.<XDR FQDN>/xdr/api/v1/<request>

https://api.<XDR FQDN>/xdr/api/v3/kuma/<request> (для API, специфичного для KUMA)

Пример:

https://api.example.com/xdr/api/v1/

https://api.example.com/xdr/api/v3/kuma/ (для API, специфичного для KUMA)

Создание токена

Чтобы сгенерировать пользовательский API-токен:

1. В главном окне приложения перейдите в раздел Параметры → API-токен.
2. Нажмите на кнопку Добавить токен.
3. В панели Добавить токен настройте параметры токена.
   1. Нажмите на Дата истечения срока действия и используйте календарь, чтобы указать дату истечения срока действия токена. Если вы хотите выключить автоматическое истечение срока действия токена, установите флажок Без срока действия.

      Максимальный срок действия – 365 дней.

      Рекомендуется включить автоматическое истечение срока действия для токенов, у которых есть доступ к методам POST.

   2. Установите флажки рядом с методами API, к которым вы хотите разрешить доступ.
4. Нажмите на кнопку Сгенерировать.
5. Нажмите на кнопку Копировать и закрыть.

   Вы не сможете скопировать токен позже.

Токен создан и скопирован в буфер обмена. Сохраните токен любым удобным способом.

Авторизация запросов API

Каждый запрос API должен включать авторизацию с использованием токенов. Пользователь, чей токен используется для запроса API, должен иметь разрешения на выполнение этого типа запроса.

Каждый запрос должен сопровождаться следующим заголовком:

Authorization: Bearer <token>

Возможные ошибки