Исходный код вики API-токены

Версия 13.4 от admin на 2026/09/17 15:36

Скрыть последних авторов
admin 2.1 1 В данном разделе приведены сведения о создании API-токенов для авторизации внешних систем в сети НЕЙРОСС. Общие сведения об учетных записях приведены в разделе ~[[[Управление учётными записями Платформы НЕЙРОСС>>doc:ui.ui-users-roles.ui-accounts-platform.WebHome]]].
admin 2.2 2
admin 11.5 3 == Общие сведения ==
4
admin 13.3 5
6 Доступ к HTTP API Платформы НЕЙРОСС для внешних систем и интеграций выполняется по учётной записи пользователя или по API-токену. API-токен создается для конкретной учётной записи и наследует её права: внешняя система получает доступ только к тем функциям, которые разрешены выбранному пользователю.
7
admin 13.4 8 |=Способ авторизации|=Описание
admin 13.3 9 |(((
10 Учётная запись
11 )))|(((
12 Стандартная авторизация пользователя (логин и пароль)
13 )))
14 |(((
15 API-токен
16 )))|(((
17 Альтернативный способ для программного доступа без передачи пароля
18 )))
19
admin 13.4 20 Для одного пользователя можно настроить один или несколько API-токенов. По умолчанию токены не создаются — их нужно создать вручную.
admin 13.3 21
22 API-токен авторизует запрос только при одновременном выполнении условий:
23
24 * лицензия Платформы активна;
25 * срок действия токена не истёк (для токенов с ограниченным сроком).
26
admin 13.4 27 Сервер считывает значение API-токена из HTTP-заголовка с фиксированным именем. Имя заголовка и описание запросов предоставляются при приобретении лицензии с поддержкой API хъ.
admin 13.3 28
admin 13.1 29 [[image:api-token-wnd.png||height="297" width="900"]]
admin 11.5 30
admin 11.2 31 == {{id name="Настройкафункцииуправленияграфикамиработы-Лицензионнаяполитика"/}}Лицензионная политика ==
admin 11.1 32
admin 11.4 33 Для обеспечения функции авторизации по API-токену проверьте наличие требуемых лицензий в параметрах лицензии ~[[[Просмотр параметров и обновление лицензии>>doc:ui.node.basic.license-update.WebHome]]]. В противном случае требуется приобрести лицензии ~[[[Лицензирование Платформы НЕЙРОСС>>doc:neyross.licensing.WebHome]]].
admin 11.1 34
admin 11.2 35 |=(((
36 Тип узла
37 )))|=(((
38 Параметр лицензии
39 )))|=(((
40 Комментарий
41 )))
admin 11.3 42 |(% rowspan="1" %)(((
admin 11.2 43 Платформа НЕЙРОСС
44
45
admin 11.3 46 )))|Использование API-токенов авторизации|(((
admin 11.5 47 Доступ к разделу создания API-токенов в приложении [[Пользователи, роли и права>>doc:ui.ui-users-roles.WebHome]].
admin 11.2 48 )))
49
admin 11.4 50 == (% style="font-family:inherit; font-size:20px" %)Создание токена(%%) ==
admin 11.2 51
admin 5.1 52 Нажмите на кнопку **Создать токен**.
admin 2.2 53
admin 5.2 54 В отобразившемся окне заполните поля согласно таблице ниже.
admin 2.3 55
admin 7.1 56 [[image:api-token-add.png]]
57
admin 2.3 58 |=Поле|=Комментарий
admin 2.4 59 |Пользователь|(((
60 Выберите из раскрывающегося списка учетную запись пользователя, которому требуется доступ по API-токену.
admin 2.3 61
admin 3.1 62 Токен может быть создан только для ранее созданной учетной записи. Права токена ограничены правами выбранной учетной записи.
admin 2.4 63 )))
admin 3.1 64 |Название токена|Введите любое текстовое описание токена.
65 |Действителен по|(((
66 Укажите срок действия токена или оставьте поле пустым.
67
68 * Токен без срока действия является бессрочным. Для отзыва бессрочного токена просто удалите его.
admin 4.1 69 * Токен с указанным сроком действия активен до истечения срока с указанием секунд. Для ввода срока действия предоставляется инструмент Календарь ~[[[Инструмент Календарь>>doc:ui.tools.ui-tool-calendar.WebHome]]].
admin 3.1 70 )))
admin 5.2 71
72
73
74 После ввода всех данных нажмите на кнопку **Создать**.
75
admin 8.2 76
77 Будет создан токен для указанной учетной записи с указанным сроком действия.
78
79 [[image:api-token-copy.png]]
80
81 (% class="box warningmessage" %)
82 (((
admin 10.1 83 **ВАЖНО**
84
85 Обязательно скопируйте токен в буфер обмена! Токен отображается **ТОЛЬКО ОДИН РАЗ**. Восстановление токена невозможно. Потребуется удалить и создать новый токен.
admin 8.2 86 )))
admin 9.2 87
admin 11.4 88 == Продление токена ==
admin 9.2 89
90 Платформа НЕЙРОСС обеспечивает возможность группового продления срока действия токенов. 

Интерфейс НЕЙРОСС