Документация REST API
Актуальная документация по методам REST API в формате Swagger доступна после установки платформы по адресуhttp(s)://{domain_name}/v3/api/v1/swagger/index.html
где {domain_name} - IP-адрес или доменное имя вашей платформы.
Чтобы получить токен для взаимодействия с публичным API, необходимо отправить отправить POST запрос на сервер к которому необходимо получить токен доступа:POST http(s)://<domain>/v3/keycloak/realms/Visiology/protocol/openid-connect/token
где <domain> – домен или IP-адрес сервера платформы.
Пример запроса в Postman:
POST http://192.168.42.87/v3/keycloak/realms/Visiology/protocol/openid-connect/token
| Key | Value |
|---|---|---|
Body x-www-form-urlencoded | username | Имя пользователя. |
password | Пароль пользователя. | |
grant_type |
| |
client_id |
|
Для отправки запроса нажмите Send в правом верхнем углу окна:
Если вам не удается получить токен доступа, обратитесь за помощью к глобальному администратору платформы.
Полученный токен необходимо ввести при авторизации на странице
http(s)://{domain_name}/v3/api/v1/swagger/index.html
Для этого сделайте следующее:
Скопируйте полученный вами токен аутентификации.
Перейдите на страницу документации API по адресу
http(s)://{domain_name}/v3/api/v1/swagger/index.htmlВ правом верхнем углу страницы нажмите кнопку Authorize:
В открывшемся окне введите слово Bearer, поставьте один пробел и вставьте скопированный токен. Затем нажмите кнопку Authorize:
Срок действия токена составляет 10 минут. По истечении указанного срока потребуется повторить процедуру получения нового токена и повторной авторизации.
Смотрите также
Нужна дополнительная помощь?