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

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

Управление
- Копировать
Действия
- Экспорт
- Предварительный просмотр
Просмотр

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