Авторизация в запросах Macroscop REST API🔗
Поддерживается два способа передачи учётных данных.
Передача данных авторизации через GET-параметры запроса🔗
Этот способ предполагает передачу данных авторизации через GET-параметры запроса. Эти параметры можно использовать не только в GET-запросах, но и в POST и PUT-запросах при работе с REST API.
Параметры запроса:
Параметр |
Тип |
Описание |
|---|---|---|
login |
string |
Имя пользователя (например, root или novikov@ent.macroscop.com для пользователей AD). |
password |
string |
MD5-хэш пароля для внутренних пользователей Macroscop или Base64 для пользователей AD. |
usertype |
string |
Тип пользователя: internal для внутренних пользователей Macroscop или ActiveDirectory для пользователей AD. |
Примеры запросов:
Запрос списка камер для внутреннего пользователя user с паролем 1234:
curl --location "localhost:8080/api/channels?login=user&password=81dc9bdb52d04dc20036dbd8313ed055"
Запрос списка камер для AD-пользователя novikov@ent.macroscop.com с паролем (параметр password):
curl --location "localhost:8080/api/channels?login=novikov%40ent.macroscop.com&usertype=ActiveDirectory&password=cGFzc3dvcmQ%3D"
HTTP Basic Authentication🔗
Этот способ является стандартным, так как он поддерживается большинством браузеров и различных HTTP-клиентов, таких как POSTMAN, а также библиотеками (HttpClient, RestSharp) для различных языков программирования.
Для использования данной авторизации необходимо добавить в HTTP-запрос заголовок авторизации следующего вида: Authorization: Basic Base64(login:password).
Например, Authorization: Basic bm92aWtvdkBlbnQubWFjcm9zY29wLmNvbTpQbGFpblRleHRBZFBhc3N3b3Jk.
Параметры запроса:
Параметр |
Описание |
Формат |
|---|---|---|
login |
Имя пользователя (например, root или novikov@ent.macroscop.com для пользователей AD). |
string |
password |
Пароль пользователя: MD5-хэш пароля для внутренних пользователей Macroscop или пароль в чистом виде для пользователей AD. |
string |
usertype |
Чтобы Basic-авторизация работала для пользователей Active Directory, в запрос необходимо добавить следующий заголовок: UserType: ActiveDirectory |
string |
Примеры запросов:
Запрос списка камер для внутреннего пользователя user с паролем 1234:
curl --location "localhost:8080/api/channels" --header "Authorization: Basic dXNlcjo4MWRjOWJkYjUyZDA0ZGMyMDAzNmRiZDgzMTNlZDA1NQ=="
Запрос списка камер для AD-пользователя novikov@ent.macroscop.com с паролем (параметр password):
curl --location "localhost:8080/api/channels" --header "UserType: ActiveDirectory" --header "Authorization: Basic bm92aWtvdkBlbnQubWFjcm9zY29wLmNvbTpQbGFuVGV4dEFkUGFzc3dvcmQ="