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

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

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

Сводка

Подробности

Свойства страницы
Содержимое
... ... @@ -1,9 +1,43 @@
1 1  В данном разделе приведены сведения о создании API-токенов для авторизации внешних систем в сети НЕЙРОСС. Общие сведения об учетных записях приведены в разделе ~[[[Управление учётными записями Платформы НЕЙРОСС>>doc:ui.ui-users-roles.ui-accounts-platform.WebHome]]].
2 2  
3 -== {{id name="Настройкафункцииуправленияграфикамиработы-Лицензионнаяполитика"/}}Лицензионная политика ==
3 +== Общие сведения ==
4 4  
5 -Для обеспечения функции авторизации по API-токену проверьте наличие требуемых лицензий в параметрах лицензии ~[[[Просмотр параметров и обновление лицензии>>doc:ui.node.basic.license-update.WebHome]]]. В противном случае требуется приобрести лицензию ~[[[Лицензирование Платформы НЕЙРОСС>>doc:neyross.licensing.WebHome]]].
6 6  
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 ~[[[Лицензионная политика>>doc:||anchor="licence-policy"]]].
28 +
29 +== Возможности API ==
30 +
31 +Предоставляемое API обеспечивает:
32 +
33 +* Работу с функциональными элементами НЕЙРОСС: мониторинг состояний и управление элементами;
34 +* Работу с событиями: вычитывание «живых» и архивных событий (событий СКУД, ОТС и проч.);
35 +* Работу с медиаданными: получение «живого» видео, спапшотов и видеоархивов, PTZ-управление, в том числе переключение препозиций, экспорт видеофрагментов, создание и удаление задач на запись.
36 +
37 +== {{id name="licence-policy"/}}Лицензионная политика ==
38 +
39 +Для обеспечения функции авторизации по API-токену проверьте наличие требуемых лицензий в параметрах лицензии ~[[[Просмотр параметров и обновление лицензии>>doc:ui.node.basic.license-update.WebHome]]]. В противном случае требуется приобрести лицензии ~[[[Лицензирование Платформы НЕЙРОСС>>doc:neyross.licensing.WebHome]]].
40 +
7 7  |=(((
8 8  Тип узла
9 9  )))|=(((
... ... @@ -11,25 +11,35 @@
11 11  )))|=(((
12 12  Комментарий
13 13  )))
14 -|(% rowspan="2" %)(((
48 +|(% rowspan="1" %)(((
15 15  Платформа НЕЙРОСС
16 16  
17 17  
18 -)))|(((
19 -[Доступ] Управление графиками работы
20 -)))|(((
21 -Использование подсистемы организации сменных графиков работы; включает первое рабочее место //АРМ табельщика//. Учёт рабочего времени, получение данных по пропускам и событиям доступа обеспечивают **дополнительно приобретаемые лицензии** НЕЙРОСС Отчёты: //НЕЙРОСС Доступ УРВ// //Базовый, НЕЙРОСС Доступ УРВ// //Про.//
52 +)))|Использование API-токенов авторизации|(((
53 +Доступ к разделу создания API-токенов в приложении [[Пользователи, роли и права>>doc:ui.ui-users-roles.WebHome]].
22 22  )))
23 -|(((
24 -[Доступ] Количество АРМ с функцией управления графиками работы
25 -)))|(((
26 -Возможность запуска АРМ НЕЙРОСС Доступ График. Лицензирование по числу активных пользователей (рабочих мест).
27 -)))
28 28  
56 +== Рекомендации по безопасности ==
29 29  
58 +Для обмена по HTTP рекомендуется протокол HTTPS.
30 30  
31 -== Создание токена ==
60 +В составе Платформы НЕЙРОСС есть встроенный HTTPS-сервер. При каждой установке автоматически создаются:
32 32  
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 +
75 +== (% style="font-family:inherit; font-size:20px" %)Создание токена(%%) ==
76 +
33 33  Нажмите на кнопку **Создать токен**.
34 34  
35 35  В отобразившемся окне заполните поля согласно таблице ниже.
... ... @@ -66,6 +66,26 @@
66 66  Обязательно скопируйте токен в буфер обмена! Токен отображается **ТОЛЬКО ОДИН РАЗ**. Восстановление токена невозможно. Потребуется удалить и создать новый токен.
67 67  )))
68 68  
69 -== Редактирование токена ==
113 +== {{id name="edit"/}}Редактирование токена ==
70 70  
71 -Платформа НЕЙРОСС обеспечивает возможность группового продления срока действия токенов. 
115 +Вы можете изменить название и/или срок действия токена. Для этого в строке токена нажмите на кнопку [[image:ui.node.WebHome@btn_prp.png]] и в отобразившемся меню выберите **Изменить**.
116 +
117 +В отобразившемся окне введите новое название и/или срок действия. Сохраните изменения.
118 +
119 +[[image:api-token-edit.png]]
120 +
121 +== Продление токена ==
122 +
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
Содержимое
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

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