Cómo enviar una solicitud a Rest Web API

Tipo de solicitud

La tarea REST Web API admite diferentes métodos HTTP que se pueden usar de acuerdo con sus objetivos de supervisión. Al seleccionar una solicitud GET, simplemente se recuperarán datos de la API web. Aunque los parámetros de solicitud se pueden incluir en la dirección URL, se recomienda utilizar métodos dedicados para insertar la carga en una API.

Para enviar cualquier información personalizada, cambiar datos o desencadenar cualquier flujo o evento, use tipos de solicitudes como POST, PUT o PATCH. En este caso, para especificar el cuerpo de la solicitud, vaya a la sección Publicar datos.

Si establece el tipo de solicitud en POST, PUT o PATCH, pero no especifica los parámetros de solicitud en la sección Registrar datos, el tipo de solicitud se volverá a cambiar a GET al guardar la tarea.

Autenticación

Si la API requiere autenticación, proporcione las credenciales en la sección Autenticación básica. Si la autenticación basada en token es el método utilizado, siga las recomendaciones proporcionadas para las API basadas en OAuth 2.0 y configure los parámetros de autenticación de forma similar.

Datos de publicación

En esta sección puede proporcionar fácilmente cualquier entidad de solicitud, como JSON.

Para especificar el cuerpo de la solicitud, simplemente pegue o escriba contenido JSON en el campo. El sistema analizará automáticamente el código y se le pedirá que seleccione un encabezado de tipo de contenido basado en el tipo de cuerpo de la solicitud. Además, puede proporcionar un encabezado de tipo de contenido personalizado si es necesario.

Una vez especificado, el tipo de contenido se agregará automáticamente a la sección Encabezados.

Validación de resultados

En general, no es suficiente simplemente realizar una llamada a una API, el propósito de asegurarse de que la respuesta de la API contiene datos que se esperaba recibir. Para verificar la respuesta de la API, es suficiente encontrar algunas palabras clave que coincidan exactamente en la respuesta. Conociendo el contenido de la respuesta de la API, puede proporcionar las palabras clave en la sección Validación de contenido. Para obtener más información, consulte el artículo Palabra clave.

Casos de uso

Consideremos una API REST de correo electrónico como un ejemplo. Para supervisar el servicio, necesitamos enviar la solicitud POST al punto de conexión de API correspondiente, junto con los detalles de correo electrónico en el cuerpo de la solicitud. Para ello, tenemos que proporcionar la dirección URL del punto de conexión y seleccionar el tipo de solicitud POST.

Dado que la API REST de correo electrónico requiere autenticación básica, también necesitamos proporcionar las credenciales en la sección correspondiente.

En la sección Post Data, especificaremos la matriz JSON con detalles de correo electrónico y seleccionaremos el tipo de encabezado para insertar la carga en el punto de conexión de la API.

El siguiente paso es especificar una palabra clave que se buscará en la respuesta de la API para su validación.