Supervisión de las API basadas en OAuth 2.0

El objetivo principal de la primera tarea Get Token es obtener un token de acceso para que la aplicación tenga acceso a la API de servicio. Si se realiza correctamente, el token de acceso se puede recuperar de la respuesta de la API de servicio y usarse en las solicitudes de API posteriores. Además, la tarea comprueba el intercambio de un código de autorización de aplicación para el token de acceso. En caso de errores, se generará la alerta para el dispositivo.

Para crear un dispositivo, haga clic en Nuevo dispositivo en la página Administrador de dispositivos y seleccione la tarea HTTP/S.

Url

Para configurar la tarea, necesitamos generar la solicitud de token de acceso al servidor de autorización. En el campo URL, especifique la dirección URL del servidor de autorización de API con el siguiente formato https://authorization-server.com/oauth/authorize. La dirección URL exacta depende del servicio al que se conecte.

Comprobación de certificado/SSL

Habilite las comprobaciones de certificados SSL.

Tipo de solicitud y datos de publicación

Los parámetros de autenticación de cliente(identificador de cliente y secreto de cliente),URI de redireccionamiento y códigode autorización se deben proporcionar en la solicitud al servidor de autorización. Usemos el método POST (el campo Tipo de solicitud) para enviar los detalles y el código de la aplicación.

En el campo Registrar datos, necesitamos especificar los siguientes atributos del cuerpo de la solicitud:

• client_id – el identificador de la aplicación, emitido en el primer registro de la aplicación en el servidor de autorización.
• client_secret – emitido en el primer registro de su solicitud en el servidor de autorización.
• código – el código de autorización recibido del servidor de autorización.
• grant_type – debe establecerse en “authorization_code“.
• redirect_uri: la dirección URL debe coincidir con la dirección URL de redirección que ha registrado previamente con la aplicación.

Como resultado de la ejecución de la tarea, recibiremos una respuesta JSON con el token de acceso del servidor de autorización en el cuerpo de la respuesta.

Validación de contenido

Para asegurarse de que la respuesta del servidor devuelve el token de acceso y el token de actualización (se usa si expira el token de acceso), especifique las siguientes palabras clave:

• access_token
• refresh_token

Para configurar otros campos de tarea, si es necesario, consulte Agregar/Editar una tarea HTTP(S).

Una vez finalizada la instalación, haga clic en Crear dispositivo y continúe con el paso siguiente para implementar una llamada a la API mediante el token de acceso.

Cuando se recibe la respuesta de la API con el token de acceso como resultado de la ejecución de Get Token Task, necesitamos extraer el token para llamar a la API de servicio. Por ejemplo, queremos recuperar la lista de usuarios del servicio supervisado solicitando un extremo /users.

En primer lugar, cree un script para extraer el token del cuerpo de respuesta Get Token Task a una variable. Por ejemplo, el siguiente script pasa el token y el tipo de token de la respuesta de autorización básica a la variable 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;

Para agregar una nueva tarea al dispositivo de supervisión de API configurado en el primer paso:

1. En la página Administrador de dispositivos, haga clic en el botón de acción de la fila del dispositivo.
2. En el menú de acciones, seleccione Agregar tarea.

Url

En el campo URL, especifique el URI de solicitud del recurso de servicio del que necesita extraer datos.

Comprobación de certificado/SSL

Habilite las comprobaciones de certificados SSL.

Tipo de solicitud

Seleccione el tipo de solicitud GET.

OAuth 2.0 requiere que se pase un token de acceso y un tipo de token en el encabezado Authorization de la solicitud HTTP GET, pero también puede proporcionarlo como una cadena de consulta GET o un parámetro de cuerpo POST.

Encabezados

Agregue el encabezado con el nombre del encabezado Authorization y el valor TokenAuthorization. Para convertir la variable TokenAuthorization en dinámica, haga clic en el icono de engranaje en el campo de valor y, en el cuadro de diálogo Editar valor, seleccione Dinámico.

El campo Valor dinámico se marcará con los corchetes.

Preparar guión

Agregue el script para pasar el token de acceso.

Validación de contenido

Para comprobar los datos devueltos con la respuesta del servicio, también puede especificar las palabras clave correspondientes. Por ejemplo, varios nombres de usuario que esperaba recuperar del servicio.

Para configurar otros campos de tarea, consulte Agregar/editar una tarea HTTP(S).