Добавление ключей APIEOL

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

Атрибуты ключа API:

• название ключа – должно быть уникальным (можно изменить в профиле ключа, во вкладке Основное);
• значение ключа – уникальная последовательность символов, генерируется автоматически при создании ключа;
• режим аутентификации – с помощью какого атрибута будет проходить аутентификация;
• доступ к пространствам – к каким пространствам данных имеет доступ ключ.

Возможные действия:

1. Добавить ключ;
2. При нажатии значка контекстного меню появляется список выбора действий с данным элементом:
   • при нажатии Настроить происходит переход в профиль ключа во вкладку Привилегии;
   • удалить (кнопка активна, когда выбран хотя бы один ключ);
3. Поиск необходимого ключа.

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

Необходимо контролировать уникальность названия Ключа API:

• сертификат является файлом с расширением .crt или .cert;
• обновить сертификат API ключа возможно. Для этого нужно загрузить новый сертификат в профиле ключа. Старый сертификат становится недействительным;
• для предустановленного безопасного API ключа используется имя Агент мониторинга.

При добавлении ключа выберите режим аутентификации:

• SSL-сертификат;
• стандартный;
• kerberos;
• стандартная Windows.

При выборе SSL-сертификата можно:

• задать название Ключа API;
• загрузить сертификат;
• удалить загруженный файл.

При выборе Стандартный можно задать название Ключа API.

Далее в привилегиях Ключа API установите необходимые операции доступа для Ключа API. Подробнее с привилегиями в системе можно ознакомиться в разделе Ролевая модель.

На стороне внешней системы необходимо произвести настройку https-соединения, хранилища сертификатов, а также клиентских сертификатов. После чего можно выполнять GraphQL-запросы к системе. Для возможности соединения в системе в обязательном порядке должна быть выполнена настройка клиентской авторизации.