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

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

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

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
11.2	30	== {{id name="Настройкафункцииуправленияграфикамиработы-Лицензионнаяполитика"/}}Лицензионная политика ==
11.1	31
11.4	32	Для обеспечения функции авторизации по API-токену проверьте наличие требуемых лицензий в параметрах лицензии ~[[[Просмотр параметров и обновление лицензии>>doc:ui.node.basic.license-update.WebHome]]]. В противном случае требуется приобрести лицензии ~[[[Лицензирование Платформы НЕЙРОСС>>doc:neyross.licensing.WebHome]]].
11.1	33
11.2	34	\|=(((
	35	Тип узла
	36	)))\|=(((
	37	Параметр лицензии
	38	)))\|=(((
	39	Комментарий
	40	)))
11.3	41	\|(% rowspan="1" %)(((
11.2	42	Платформа НЕЙРОСС
	43
	44
11.3	45	)))\|Использование API-токенов авторизации\|(((
11.5	46	Доступ к разделу создания API-токенов в приложении [[Пользователи, роли и права>>doc:ui.ui-users-roles.WebHome]].
11.2	47	)))
	48
13.6	49
	50
	51	== Рекомендации по безопасности ==
	52
	53	Для обмена по HTTP рекомендуется протокол HTTPS.
	54
	55	В составе Платформы НЕЙРОСС есть встроенный HTTPS-сервер. При каждой установке автоматически создаются:
	56
	57	* уникальный сертификат удостоверяющего центра (CA);
	58	* серверный сертификат, подписанный этим CA.
	59
	60	Сертификат CA в формате .crt можно скачать через веб-сервер Платформы НЕЙРОСС и установить на клиенте, чтобы доверять HTTPS-соединению без предупреждений браузера.
	61
13.7	62	HTTPS можно настроить иначе — в том числе с использованием общедоступных CA (например, Let's Encrypt). В таких случаях порядок установления HTTPS-подключения уточняйте для конкретной инсталляции в документации по развёртыванию.
13.6	63
	64	== Окно раздела ==
	65
	66	[[image:api-token-wnd.png\|\|height="297" width="900"]]
	67
14.1	68	Окно раздела содержит список токенов с указанием пользователя — «владельца» токена, его названия, времени создания и срока действия. Для бессрочных токенов срок действия не ограничен. Если был хотя бы один авторизованный запрос с использованием токена, указывается время последнего запроса. Инструменты раздела позволяют удалить токен или изменить его название и срок действия. Поддерживается групповое продление токенов.
13.7	69
11.4	70	== (% style="font-family:inherit; font-size:20px" %)Создание токена(%%) ==
11.2	71
5.1	72	Нажмите на кнопку Создать токен.
2.2	73
5.2	74	В отобразившемся окне заполните поля согласно таблице ниже.
2.3	75
7.1	76	[[image:api-token-add.png]]
	77
2.3	78	\|=Поле\|=Комментарий
2.4	79	\|Пользователь\|(((
	80	Выберите из раскрывающегося списка учетную запись пользователя, которому требуется доступ по API-токену.
2.3	81
3.1	82	Токен может быть создан только для ранее созданной учетной записи. Права токена ограничены правами выбранной учетной записи.
2.4	83	)))
3.1	84	\|Название токена\|Введите любое текстовое описание токена.
	85	\|Действителен по\|(((
	86	Укажите срок действия токена или оставьте поле пустым.
	87
	88	* Токен без срока действия является бессрочным. Для отзыва бессрочного токена просто удалите его.
4.1	89	* Токен с указанным сроком действия активен до истечения срока с указанием секунд. Для ввода срока действия предоставляется инструмент Календарь ~[[[Инструмент Календарь>>doc:ui.tools.ui-tool-calendar.WebHome]]].
3.1	90	)))
5.2	91
	92
	93
	94	После ввода всех данных нажмите на кнопку Создать.
	95
8.2	96
	97	Будет создан токен для указанной учетной записи с указанным сроком действия.
	98
	99	[[image:api-token-copy.png]]
	100
	101	(% class="box warningmessage" %)
	102	(((
10.1	103	ВАЖНО
	104
	105	Обязательно скопируйте токен в буфер обмена! Токен отображается ТОЛЬКО ОДИН РАЗ. Восстановление токена невозможно. Потребуется удалить и создать новый токен.
8.2	106	)))
9.2	107
14.1	108	== Редактирование токена ==
	109
15.2	110	Вы можете изменить название и/или срок действия токена. Для этого в строке токена нажмите на кнопку [[image:ui.node.WebHome@btn_prp.png]] и в отобразившемся меню выберите Изменить.
14.1	111
15.3	112	В отобразившемся окне введите новое название и/или срок действия. Сохраните изменения.
15.2	113
	114	[[image:api-token-edit.png]]
	115
11.4	116	== Продление токена ==
9.2	117
15.3	118	Платформа НЕЙРОСС обеспечивает возможность одинарного и группового продления срока действия токенов. Продление срока действия одного токена осуществляется через процедуру редати