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

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

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

Сводка

Подробности

Свойства страницы
Содержимое
... ... @@ -5,9 +5,7 @@
5 5  
6 6  Доступ к HTTP API Платформы НЕЙРОСС для внешних систем и интеграций выполняется по учётной записи пользователя или по API-токену. API-токен создается для конкретной учётной записи и наследует её права: внешняя система получает доступ только к тем функциям, которые разрешены выбранному пользователю.
7 7  
8 -Авторизация
9 -
10 -|=Способ|=Описание
8 +|=Способ авторизации|=Описание
11 11  |(((
12 12  Учётная запись
13 13  )))|(((
... ... @@ -19,7 +19,7 @@
19 19  Альтернативный способ для программного доступа без передачи пароля
20 20  )))
21 21  
22 -Для одного пользователя можно настроить один или несколько API-токенов. По умолчанию токены не создаются — их нужно выпустить вручную в приложении Пользователи, роли и права.
20 +Для одного пользователя можно настроить один или несколько API-токенов. По умолчанию токены не создаются — их нужно создать вручную.
23 23  
24 24  API-токен авторизует запрос только при одновременном выполнении условий:
25 25  
... ... @@ -26,12 +26,16 @@
26 26  * лицензия Платформы активна;
27 27  * срок действия токена не истёк (для токенов с ограниченным сроком).
28 28  
29 -Сервер считывает значение API-токена из HTTP-заголовка с фиксированным именем. Имя заголовка и описание запросов предоставляются при приобретении лицензии с поддержкой API.
27 +Сервер считывает значение API-токена из HTTP-заголовка с фиксированным именем. Имя заголовка и описание запросов предоставляются при приобретении лицензии с поддержкой API ~[[[Лицензионная политика>>doc:||anchor="licence-policy"]]].
30 30  
31 -[[image:api-token-wnd.png||height="297" width="900"]]
29 +== Возможности API ==
32 32  
33 -== {{id name="Настройкафункцииуправленияграфикамиработы-Лицензионнаяполитика"/}}Лицензионная политика ==
31 +Предоставляемое API обеспечивает:
34 34  
33 +* Работу с функциональны
34 +
35 +== {{id name="licence-policy"/}}Лицензионная политика ==
36 +
35 35  Для обеспечения функции авторизации по API-токену проверьте наличие требуемых лицензий в параметрах лицензии ~[[[Просмотр параметров и обновление лицензии>>doc:ui.node.basic.license-update.WebHome]]]. В противном случае требуется приобрести лицензии ~[[[Лицензирование Платформы НЕЙРОСС>>doc:neyross.licensing.WebHome]]].
36 36  
37 37  |=(((
... ... @@ -49,6 +49,27 @@
49 49  Доступ к разделу создания API-токенов в приложении [[Пользователи, роли и права>>doc:ui.ui-users-roles.WebHome]].
50 50  )))
51 51  
54 +
55 +
56 +== Рекомендации по безопасности ==
57 +
58 +Для обмена по HTTP рекомендуется протокол HTTPS.
59 +
60 +В составе Платформы НЕЙРОСС есть встроенный HTTPS-сервер. При каждой установке автоматически создаются:
61 +
62 +* уникальный сертификат удостоверяющего центра (CA);
63 +* серверный сертификат, подписанный этим CA.
64 +
65 +Сертификат CA в формате .crt можно скачать через веб-сервер Платформы НЕЙРОСС и установить на клиенте, чтобы доверять HTTPS-соединению без предупреждений браузера.
66 +
67 +HTTPS можно настроить иначе — в том числе с использованием общедоступных CA (например, Let's Encrypt). В таких случаях порядок установления HTTPS-подключения уточняйте для конкретной инсталляции в документации по развёртыванию.
68 +
69 +== Окно раздела ==
70 +
71 +[[image:api-token-wnd.png||height="297" width="900"]]
72 +
73 +Окно раздела содержит список токенов с указанием пользователя — «владельца» токена, его названия, времени создания и срока действия. Для бессрочных токенов срок действия не ограничен. Если был хотя бы один авторизованный запрос с использованием токена, указывается время последнего запроса. Инструменты раздела позволяют удалить токен или изменить его название и срок действия. Поддерживается групповое продление токенов.
74 +
52 52  == (% style="font-family:inherit; font-size:20px" %)Создание токена(%%) ==
53 53  
54 54  Нажмите на кнопку **Создать токен**.
... ... @@ -87,6 +87,26 @@
87 87  Обязательно скопируйте токен в буфер обмена! Токен отображается **ТОЛЬКО ОДИН РАЗ**. Восстановление токена невозможно. Потребуется удалить и создать новый токен.
88 88  )))
89 89  
113 +== {{id name="edit"/}}Редактирование токена ==
114 +
115 +Вы можете изменить название и/или срок действия токена. Для этого в строке токена нажмите на кнопку [[image:ui.node.WebHome@btn_prp.png]] и в отобразившемся меню выберите **Изменить**.
116 +
117 +В отобразившемся окне введите новое название и/или срок действия. Сохраните изменения.
118 +
119 +[[image:api-token-edit.png]]
120 +
90 90  == Продление токена ==
91 91  
92 -Платформа НЕЙРОСС обеспечивает возможность группового продления срока действия токенов. 
123 +Платформа НЕЙРОСС обеспечивает возможность одинарного и группового продления срока действия токенов. Продление срока действия одного токена осуществляется через процедуру [[редактирования>>doc:||anchor="edit"]].
124 +
125 +Для группового продления:
126 +
127 +1. Выберите требуемые токены.
128 +1. Нажмите на кнопку Изменить.
129 +1. В отобразившемся окне введите новый срок действия, сохраните изменения.
130 +
131 +[[image:api-token-renew.png]]
132 +
133 +== Удаление токена ==
134 +
135 +Возможно одиночное и групповое удаление токенов. Для удаления одного токена вы можете воспользоваться командой Удалить в строке токена. Также вы можете выделить требуемые токены и нажать на кнопку Удалить в верхней части окна. Фактическое удаление токенов осуществляется после подтверждения удаления.
api-token-edit.png
Автор
... ... @@ -1,0 +1,1 @@
1 +XWiki.admin
Размер
... ... @@ -1,0 +1,1 @@
1 +4.1 KB
Содержимое
api-token-renew.png
Автор
... ... @@ -1,0 +1,1 @@
1 +XWiki.admin
Размер
... ... @@ -1,0 +1,1 @@
1 +2.8 KB
Содержимое

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