Как настроить учётную запись для автоматизации?

1. Создайте Учётную запись Робота¶

1. В портале NGENIX Multidesk перейдите на страницу Роботы раздела Об аккаунте (боковое меню настроек Аккаунта).
2. Нажмите кнопку +Добавить робота, и в открывшемся диалоговом окне задайте Название для создаваемой Учётной записи.

3. В открывшейся странице Управление профилем робота при необходимости вы можете:

   1. Переименовать Учетную запись Робота используя поле Название.

   2. Определить Срок жизни робота.

      Мы рекомендуем указывать реальный срок действия учетных записей для автоматизаций и интеграций со сторонними системами и не делать их бессрочными. Это повысит безопасность ваших систем. Если API-токен бессрочной Учетной записи Робота будет скомпрометирован, вы можете узнать об этом слишком поздно, что может поставить под угрозу информационную безопасность ваших веб-ресурсов.

      По умолчанию, если явно не указать Срок жизни робота на странице Управление профилем робота, то такая Учётная запись Робота будет бессрочной!

   3. (Опционально) Ограничить список IP-префиксов через поле Укажите список IP-префиксов, с которых можно работать данной автоматизации, по одному адресу на строку с которых будет разрешён доступ к API с использованием технического API-токена Учетной записи Робот.

   4. В разделе Конфигурация прав доступа к ручкам API рекомендуется сконфигурировать доступ для Учетной записи Робот и её технического API-токена к конкретными ручками API, а также ограничить список используемых методов. Для этого воспользуйтесь кнопкой +Добавить ручку API, при добавлении ручек API требуется**задать:

      1. URL - должен содержать <path> и, опционально, может содержать часть ;<params>?<query> . Например: /api/v3/config/<ConfigID>;

         Вы также можете указать в пути символ * для того, чтобы разрешить условный путь для ручек API.

         Например: /reports/v1/attack/configs*

      2. Метод - доступны методы: GET, POST, PUT, PATCH, DELETE.

      3. Фильтр тела запроса - позволяет дополнительно ограничить действия доступные для конкретной ручки API. Задаётся в формате JSON строки и может быть использован только для методов: POST, PUT, PATCH. Может быть пустым, в таком случае дополнительных ограничений на ручку API не налагается.

         Например, задано ограничение на ручку API: 

         • URL: https://api.ngenix.net/api/v3/config
         • Метод: POST
         • Фильтр тела запроса: {"customerRef": {"id": 100500}}

         Это означает, что запрос к API может быть выполнен на указанную ручку только методом POST и только при наличии в теле запроса customerRef со значением id равным 100500.

      4. Нажмите значок галочки для подтверждения настроек добавленной ручки API.

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

   5. Сохраните указанные настройки Учётной записи робота с помощью кнопки Сохранить изменения.

4. На странице Управление профилем робота обратите внимание на поле Логин - это автоматически генерируемый email, его необходимо будет использовать для доступа к API при работе через API-токен Учётной записи Робота.

2. Получите технический API-токен ранее созданной Учётной записи Робота¶

1. На странице Управление профилем робота рядом с полем Токен для авторизации в API нажмите кнопку Сгенерировать новый, - для генерации технического API-токена Учётной записи Робот.
2. В открывшемся диалоговом окне подтвердите генерацию API-токена кнопкой Да, сгенерировать. Сохраните полученный токен локально, после закрытия окна с токеном повторно посмотреть его не удастся и придется создавать новый токен.

3. Используйте технический API-токен Учётной записи Робота в своих системах автоматизации и/или интеграциях с Платформой¶

Пример аутентификации по токену¶

curl -u <login>/token:<token> 'https://api.ngenix.net/...'

где:

• <login> — email, используемый для доступа к API при работе через API-токены Учётных записей (в случае Учётных записей Роботов email генерируется Платформой автоматически при создании Учётной записи Робот и не подлежит изменению);
• /token — команда на аутентификацию по токену;
• <token> — токен из NGENIX Multidesk.