Перейти к содержимому

Изменения документа API-токены

Редактировал(а) admin 2026/09/17 16:09
От версии 13.6
отредактировано admin
на 2026/09/17 15:38
Изменить комментарий: Auto-saved during real-time collaboration
К версии 3.1
отредактировано admin
на 2026/09/14 12:50
Изменить комментарий: К данной версии нет комментариев

Сводка

Подробности

Свойства страницы
Содержимое
... ... @@ -1,78 +1,11 @@
1 1  В данном разделе приведены сведения о создании API-токенов для авторизации внешних систем в сети НЕЙРОСС. Общие сведения об учетных записях приведены в разделе ~[[[Управление учётными записями Платформы НЕЙРОСС>>doc:ui.ui-users-roles.ui-accounts-platform.WebHome]]].
2 2  
3 -== Общие сведения ==
3 +== Создание токена ==
4 4  
5 +Нажмите на кнопку Создать токен.
5 5  
6 -Доступ к HTTP API Платформы НЕЙРОСС для внешних систем и интеграций выполняется по учётной записи пользователя или по API-токену. API-токен создается для конкретной учётной записи и наследует её права: внешняя система получает доступ только к тем функциям, которые разрешены выбранному пользователю.
7 +В отобразившемся окне заполните поля согласно таблице ниже. По окончании нажмите на кнопку **Создать**.
7 7  
8 -|=Способ авторизации|=Описание
9 -|(((
10 -Учётная запись
11 -)))|(((
12 -Стандартная авторизация пользователя (логин и пароль)
13 -)))
14 -|(((
15 -API-токен
16 -)))|(((
17 -Альтернативный способ для программного доступа без передачи пароля
18 -)))
19 -
20 -Для одного пользователя можно настроить один или несколько API-токенов. По умолчанию токены не создаются — их нужно создать вручную.
21 -
22 -API-токен авторизует запрос только при одновременном выполнении условий:
23 -
24 -* лицензия Платформы активна;
25 -* срок действия токена не истёк (для токенов с ограниченным сроком).
26 -
27 -Сервер считывает значение API-токена из HTTP-заголовка с фиксированным именем. Имя заголовка и описание запросов предоставляются при приобретении лицензии с поддержкой API ~[[[Лицензионная политика>>doc:||anchor="licence-policy"]]].
28 -
29 -
30 -== {{id name="Настройкафункцииуправленияграфикамиработы-Лицензионнаяполитика"/}}Лицензионная политика ==
31 -
32 -Для обеспечения функции авторизации по API-токену проверьте наличие требуемых лицензий в параметрах лицензии ~[[[Просмотр параметров и обновление лицензии>>doc:ui.node.basic.license-update.WebHome]]]. В противном случае требуется приобрести лицензии ~[[[Лицензирование Платформы НЕЙРОСС>>doc:neyross.licensing.WebHome]]].
33 -
34 -|=(((
35 -Тип узла
36 -)))|=(((
37 -Параметр лицензии
38 -)))|=(((
39 -Комментарий
40 -)))
41 -|(% rowspan="1" %)(((
42 -Платформа НЕЙРОСС
43 -
44 -
45 -)))|Использование API-токенов авторизации|(((
46 -Доступ к разделу создания API-токенов в приложении [[Пользователи, роли и права>>doc:ui.ui-users-roles.WebHome]].
47 -)))
48 -
49 -
50 -
51 -== Рекомендации по безопасности ==
52 -
53 -Для обмена по HTTP рекомендуется протокол HTTPS.
54 -
55 -В составе Платформы НЕЙРОСС есть встроенный HTTPS-сервер. При каждой установке автоматически создаются:
56 -
57 -* уникальный сертификат удостоверяющего центра (CA);
58 -* серверный сертификат, подписанный этим CA.
59 -
60 -Сертификат CA в формате .crt можно скачать через веб-сервер Платформы НЕЙРОСС и установить на клиенте, чтобы доверять HTTPS-соединению без предупреждений браузера.
61 -
62 -HTTPS можно настроить иначе — в том числе с общедоступными CA (например, Let's Encrypt). В таких случаях порядок установления HTTPS-подключения уточняйте для конкретной инсталляции у администратора или в документации по развёртыванию.
63 -
64 -== Окно раздела ==
65 -
66 -[[image:api-token-wnd.png||height="297" width="900"]]
67 -
68 -== (% style="font-family:inherit; font-size:20px" %)Создание токена(%%) ==
69 -
70 -Нажмите на кнопку **Создать токен**.
71 -
72 -В отобразившемся окне заполните поля согласно таблице ниже.
73 -
74 -[[image:api-token-add.png]]
75 -
76 76  |=Поле|=Комментарий
77 77  |Пользователь|(((
78 78  Выберите из раскрывающегося списка учетную запись пользователя, которому требуется доступ по API-токену.
... ... @@ -84,25 +84,5 @@
84 84  Укажите срок действия токена или оставьте поле пустым.
85 85  
86 86  * Токен без срока действия является бессрочным. Для отзыва бессрочного токена просто удалите его.
87 -* Токен с указанным сроком действия активен до истечения срока с указанием секунд. Для ввода срока действия предоставляется инструмент Календарь ~[[[Инструмент Календарь>>doc:ui.tools.ui-tool-calendar.WebHome]]].
20 +* Токен с указанным сроком действия активен до истечения срока с указанием секунд. Для ввода срока действия предоставляется инструмент Календарь ~[[[Элемент Календарь>>doc:ui.tools.ui-tool-calendar.WebHome]]].
88 88  )))
89 -
90 -
91 -
92 -После ввода всех данных нажмите на кнопку **Создать**.
93 -
94 -
95 -Будет создан токен для указанной учетной записи с указанным сроком действия.
96 -
97 -[[image:api-token-copy.png]]
98 -
99 -(% class="box warningmessage" %)
100 -(((
101 -**ВАЖНО**
102 -
103 -Обязательно скопируйте токен в буфер обмена! Токен отображается **ТОЛЬКО ОДИН РАЗ**. Восстановление токена невозможно. Потребуется удалить и создать новый токен.
104 -)))
105 -
106 -== Продление токена ==
107 -
108 -Платформа НЕЙРОСС обеспечивает возможность группового продления срока действия токенов. 
api-token-add.png
Автор
... ... @@ -1,1 +1,0 @@
1 -XWiki.admin
Размер
... ... @@ -1,1 +1,0 @@
1 -3.3 KB
Содержимое
api-token-copy.png
Автор
... ... @@ -1,1 +1,0 @@
1 -XWiki.admin
Размер
... ... @@ -1,1 +1,0 @@
1 -6.7 KB
Содержимое
api-token-wnd.png
Автор
... ... @@ -1,1 +1,0 @@
1 -XWiki.admin
Размер
... ... @@ -1,1 +1,0 @@
1 -17.2 KB
Содержимое
XWiki.ShortUrlClass[0]
Short URL code
... ... @@ -1,1 +1,0 @@
1 -16db8
Last known target (debug)
... ... @@ -1,1 +1,0 @@
1 -ui.ui-users-roles.ui-accounts-platform.ui-account-api-tokens.WebHome

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