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

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

Редактировал(а) admin 2026/09/17 16:09
От версии 13.4
отредактировано admin
на 2026/09/17 15:36
Изменить комментарий: Auto-saved during real-time collaboration
К версии 2.1
отредактировано admin
на 2026/09/11 17:28
Изменить комментарий: К данной версии нет комментариев

Сводка

Подробности

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

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