В данном разделе приведены сведения о создании API-токенов для авторизации внешних систем в сети НЕЙРОСС. Общие сведения об учетных записях приведены в разделе [Управление учётными записями Платформы НЕЙРОСС].
Общие сведения
Доступ к HTTP API Платформы НЕЙРОСС для внешних систем и интеграций выполняется по учётной записи пользователя или по API-токену. API-токен создается для конкретной учётной записи и наследует её права: внешняя система получает доступ только к тем функциям, которые разрешены выбранному пользователю.
| Способ авторизации | Описание |
|---|---|
Учётная запись | Стандартная авторизация пользователя (логин и пароль) |
API-токен | Альтернативный способ для программного доступа без передачи пароля |
Для одного пользователя можно настроить один или несколько API-токенов. По умолчанию токены не создаются — их нужно создать вручную.
API-токен авторизует запрос только при одновременном выполнении условий:
- лицензия Платформы активна;
- срок действия токена не истёк (для токенов с ограниченным сроком).
Сервер считывает значение API-токена из HTTP-заголовка с фиксированным именем. Имя заголовка и описание запросов предоставляются при приобретении лицензии с поддержкой API [Лицензионная политика].
Лицензионная политика
Для обеспечения функции авторизации по API-токену проверьте наличие требуемых лицензий в параметрах лицензии [Просмотр параметров и обновление лицензии]. В противном случае требуется приобрести лицензии [Лицензирование Платформы НЕЙРОСС].
Тип узла | Параметр лицензии | Комментарий |
|---|---|---|
Платформа НЕЙРОСС
| Использование API-токенов авторизации | Доступ к разделу создания API-токенов в приложении Пользователи, роли и права. |
Рекомендации по безопасности
Для обмена по HTTP рекомендуется протокол HTTPS.
В составе Платформы НЕЙРОСС есть встроенный HTTPS-сервер. При каждой установке автоматически создаются:
- уникальный сертификат удостоверяющего центра (CA);
- серверный сертификат, подписанный этим CA.
Сертификат CA в формате .crt можно скачать через веб-сервер Платформы НЕЙРОСС и установить на клиенте, чтобы доверять HTTPS-соединению без предупреждений браузера.
HTTPS можно настроить иначе — в том числе с использованием общедоступных CA (например, Let's Encrypt). В таких случаях порядок установления HTTPS-подключения уточняйте для конкретной инсталляции в документации по развёртыванию.
Окно раздела
Окно раздела содержит список токенов с указанием пользователя — «владельца» токена, его названия, времени создания и срока действия. Для бессрочных токенов срок действия не ограничен. Если был хотя бы один авторизованный запрос с использованием токена, указывается время последнего запроса. Инструменты раздела позволяют удалить токен или изменить его название и срок действия. Поддерживается групповое продление токенов.
Создание токена
Нажмите на кнопку Создать токен.
В отобразившемся окне заполните поля согласно таблице ниже.
| Поле | Комментарий |
|---|---|
| Пользователь | Выберите из раскрывающегося списка учетную запись пользователя, которому требуется доступ по API-токену. Токен может быть создан только для ранее созданной учетной записи. Права токена ограничены правами выбранной учетной записи. |
| Название токена | Введите любое текстовое описание токена. |
| Действителен по | Укажите срок действия токена или оставьте поле пустым.
|
После ввода всех данных нажмите на кнопку Создать.
Будет создан токен для указанной учетной записи с указанным сроком действия.
Редактирование токена
Вы можете изменить название и/или срок действия токена. Для этого в строке токена нажмите на кнопку 
и в отобразившемся меню выберите Изменить.
В отобразившемся окне введите новое название и/или срок действия. Сохраните изменения.
Продление токена
Платформа НЕЙРОСС обеспечивает возможность одинарного и группового продления срока действия токенов. Продление срока действия одного токена осуществляется через процедуру редати