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

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

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

Сводка

Подробности

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

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