Мониторинг API на основе OAuth 2.0

Основная цель первой задачи Get Token — получить токен доступа к API службы. В случае успеха токен доступа может быть извлечен из ответа API службы и использован в последующих запросах API. Кроме того, задача проверяет обмен кода авторизации приложения на токен доступа. В случае ошибок для устройства будет сгенерировано оповещение.

Чтобы создать устройство, нажмите кнопку «Новое устройство» на странице менеджера устройств и выберите задачу HTTP/S.

Url

Чтобы настроить задачу, нам необходимо создать запрос на токен доступа к серверу авторизации. В поле URL укажите URL-адрес сервера авторизации API в следующем формате https://authorization-server.com/oauth/authorize. Точный URL зависит от службы, к которой вы подключаетесь.

Проверка SSL/сертификата

Включить проверку сертификата SSL.

Запрос тип и почтовые данные

Параметры проверки подлинности клиента(идентификатор клиента и секрет клиента), перенаправление URI и код авторизации должны быть предоставлены в запросе на сервер авторизации. Давайте использовать метод POST (поле типа запроса) для отправки деталей приложения и кода.

В поле почтовых данных необходимо указать следующие атрибуты тела запроса:

• 
  client_id
  – идентификатор приложения, выданный при первой регистрации приложения на сервере авторизации.
• 
  client_secret
  – выдается при первой регистрации приложения на сервере авторизации.
• 
  код
  – код авторизации, полученный с сервера авторизации.
• grant_type

  – должны быть установлены на“authorization_code”.

• 
  redirect_uri
  – URL должен соответствовать URL-адресу перенаправления, который вы ранее зарегистрировали в приложении.

В результате выполнения задачи мы получим ответ JSON с токеном доступа от сервера авторизации в органе реагирования.

Проверка содержимого

Чтобы гарантировать, что ответ сервера возвращает токен доступа и обновляет токен (используется, если срок действия токена доступа истекает), укажите следующие ключевые слова:

• access_token
• refresh_token

При необходимости настрой на другие поля задач см.

После завершения настройки нажмите «Создайте устройство» и перейти к следующему шагу по реализации вызова API с помощью токена доступа.

Когда ответ API с токеном доступа получен в результате выполнения задачи Get Token Task, нам нужно извлечь токен для вызова API службы. Например, мы хотим получить список пользователей службы мониторинга, запросив конечную точку /пользователей.

Во-первых, создайте скрипт для извлечения токена из тела ответа Get Token Task в переменную. Например, следующий скрипт передает тип токена и токена из базового ответа авторизации в переменную TokenAuthorization:

string access_token;
string token_type;
string TokenAuthorization;

// get the authorization response from the first task
string json = (Tasks["Get Token"] as Http).body["//*"];

//convert response to the comma separated strings
string[] comas = json.Split(new Char[] { ',' });

// get the access token
int start1 = comas[0].IndexOf(":") + 2;
int length1 = comas[0].Length - start1 - 1;
access_token = comas[0].Substring(start1, length1); 

// get the token type
int start2 = comas[1].IndexOf(":") + 2;
int length2 = comas[1].Length - start2 - 1;
token_type = comas[1].Substring(start2, length2);

// set the TokenAuthorization variable to specify in the data request header 
TokenAuthorization = token_type + " " + access_token;

Чтобы добавить новую задачу в устройство мониторинга API, настроенное на первом этапе:

1. На странице Менеджер устройства нажмите кнопку действия в строке устройства.
2. В меню действий выберите задачу добавления.

Url

В поле URL укажите запрос URI вашего ресурса службы, необходимого для извлечения данных из.

Проверка SSL/сертификата

Включить проверку сертификата SSL.

Тип запроса

Выберите тип запроса GET.

OAuth 2.0 требует, чтобы тип токена доступа и токена был передан в заголовке авторизации запроса HTTP GET, но вы также можете предоставить его в качестве строки запроса GET или параметра тела POST.

Заголовки

Добавьте заголовок с именем

заголовка авторизации и значением tokenAuthorization.

Чтобы преобразовать переменную
tokenAuthorization в
динамическую, нажмите значок передач в поле значения, а в диалоге Значение редактирования выберите Динамический.

Поле динамического значения будет помечено скобками.

Подготовка сценария

Добавьте скрипт, чтобы передать токен доступа.

Проверка содержимого

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

Чтобы настроить другие поля задач, см.