Общие сведения
В документации описана спецификация REST API системы Avanpost FAM.
REST API администратора предназначен для решения задач:
- Интеграции источников пользователей для импорта данных о пользователях.
- Автоматизация управлением доступом, в том числе при помощи внешней IDM-системы.
- Другие прикладные задачи.
Спецификация методов REST API
Спецификация REST API доступа во встроенном веб-интерфейсе Swagger UI и связанной с ним JSON-спецификации OpenAPI. Публикация эндпоинтов Swagger недоступна анонимным пользовтателям и предназначена для интеграции внешних систем и используется при отладке взаимодействия с Avanpost FAM.
Публикуемые эндпоинты Swagger представлены в таблице (доступны только для администратора при заданном параметре enabled = false секции [swagger] основного конфигурационного файла):
| Путь | Назначение | Пример |
|---|---|---|
/swagger | Веб-интерфейс Swagger UI (интерактивная документация по методам API с возможностью выполнения пробных запросов). | https://fam.apidp.ru/swagger/ |
/swagger/swagger.json | JSON-спецификация API в формате OpenAPI, используемое для автоматической генерации клиентских библиотек и импорта в инструменты разработки и тестирования API. | https://fam.apidp.ru/swagger/swagger.json |
Спецификация API доступна в формате Postman по сслке: https://documenter.getpostman.com/view/17105177/2s8YzZRKvF#6cd2f26a-e75f-482f-9d63-a6f6aa9f617d
Аутентификация в REST API
Для аутентификации запросов к REST API Access Token (OAuth 2.0) в заголовке Authorization в формате Bearer Token. Данный заголовок должен быть включен во все запросы административного REST API.
Предварительные условия для выполнения запросов к REST API
Для выполнения запросов к REST API необходимо получить Access Token.
Access Token должен соответствовать следующим требованиям:
- Пользователь, от имени которого выполняются запросы, должен обладать ролью с правом на выполнение административных запросов (к примеру, системной ролью admin).
Схема взаимодействий для получения и применения Access Token приведена на рисунке:
Для аутентификации всех запросов по методу Bearer Token требуется передача Authorization Header, содержащего значение действующего Access Token.
Данный Access Token должен быть запрошен для приложения client_id=adminconsole (административная консоль) от имени пользователя, который:
- Имеет доступ к приложению adminconsole на основе групп;
- Имеет системную роль admin либо имеет доступ к необходимым полномочиям на основе custom-роли, в которую включены требуемые для выполнения операций полномочия.
Также необходимо обеспечить соблюдение срока дейтствия Access Token и при необходимости реализовать на стороне интегрируемой системы обновление токена посредством полного перезапроса или Refresh Token Grant.