...

Модуль предназначен для просмотра списка методов API платформы Robin. С их помощью можно интегрировать некоторый функции платформы в свои приложения.

Работа с модулем доступна только пользователям с ролью "Администратор Оркестратора". Поэтому если у вас нет такой роли, то модуль "API" не отобразится на панели меню.

Все запросы выполняются только под авторизованным пользователем. Подробнее про авторизацию см. на странице "API. Авторизация"

Посмотреть доступные методы можно на вкладках страницах с описанием вкладок раздела:

• Вкладка "Машины"
• API. Вкладка "Роботы"
• API. Вкладка "Очереди ресурсов"

Авторизация и получение токена

Для работы с API платформы необходимо получить токен доступа (access_token). Токен используется для заполнения заголовка авторизации в запросах к API.

Запрос для получения токена

Метод: POST 

...

Параметры тела POST-запроса:

...

Секретный ключ клиента. Пример:

lN10xJuiK9fnIlUIRxWEaJwSEKvaeckL

Значение можно получить из панели администратора в Keycloak (один из компонентов платформы Robin).

...

ID тенанта. Пример:

f9fdg366-31e5-11ee-be30-0236va230006

...

ID пользователя. Пример:

5g8c3bc4-2ff1-30a1-36ca-7sc274fa86ad

...

Идентификатор пользователя платформы Robin, под учётной записью которого будут выполняться запросы к  API. При выполнении запросов будут учитываться права пользователя в том тенанте, который вы указали в запросе.

Например, при запросе списка роботов, система вернет только тех роботов, который доступны указанному пользователю в указанном тенанте.

POST https://prod.rpa.ru:8443/realms/robin/protocol/openid-connect/token
Content-Type: application/x-www-form-urlencoded
client_id=ExternalClient&client_secret=lN10xJuiK9fnIlUIRxWEaJwSEKvaeckL&grant_type=urn:ietf:params:oauth:grant-type:token-exchange&tenant_id=f9fdg366-31e5-11ee-be30-0236va230006&user_id=5g8c3bc4-2ff1-30a1-36ca-7sc274fa86ad

Результат запроса

При успешном выполнении запроса будет возвращен ответ с кодом 200

В теле ответа будет указан access_token, который необходим при выполнении запросов к API платформы.

{
  "access_token": "ваш_токен_доступа",
  "expires_in": 3600,
  "token_type": "Bearer"
}

Примечания

• Токен необходимо указывать в запросах в заголовке Authorization:

• Токен имеет ограниченное время жизни. Срок его жизни можно узнать или изменить через интерфейс Keycloak.
Для безопасности никогда не храните секретный ключ (client_secret) в открытом виде.