Общие данные

В Платформу Радар можно обращаться из сторонних решений посредством публичного API, которое работает по протоколу HTTPS и предоставляет набор методов запрос/ответ.

Базовый пример запроса для удаленного обращения:

<Тип метода, например POST> 

https://<MASTER_KARAKEN_HOST>:9000/<сервис>/<версия API>/<ресурс>/<endpoint>

PgrApiKey: <global_api_key>
Content-Type: application/json
PgrSelectedInstance: <идентификатор инстанса>

{
    <Тело запроса>
}

Где:

<MASTER_KARAKEN_HOST> – это основная точка входа для обработки запросов;
<port> – порт для обращения. По умолчанию: 9000;
<сервис> – наименование сервиса (компонента), к которому выполняется запрос;
<версия API> – версия API по которой выполняется запрос;
<название ресурса> – название ресурса, к которому выполняется обращение. Например, service_asset_findings (Инциденты);
<endpoint> – конечная точка указанного ресурса;
<PgrApiKey> – авторизация с помощью ключа API, который можно получить в настройках кластера → параметр global_api_key. Пользователь, с помощью чьего ключа выполняется API-запрос, должен иметь права на выполнение такого типа запросов. Указывается в заголовке запроса;
<Pgr-User-ID> – авторизация с помощью идентификатора пользователя. Параметр обязателен в случае, если не используется параметр <PgrApiKey>;
<PgrSelectedInstance> – идентификатор инстанса к которому будет выполнено обращение. Указывается в заголовке запроса. Идентификатор инстанса можно скопировать по соответствующей кнопке в разделе Кластер. Управление мультиарендностью.

Примечание В документации все примеры приведены для локальных запросов, которое допускает обращение по протоколу HTTP. При удаленном обращении должен использоваться только протокол HTTPS и соответствующий порт.