Crear una colección de Postman para un conector personalizado

Postman es una aplicación para hacer solicitudes HTTP y las colecciones Postman le ayudan a organizar y agrupar las solicitudes de API relacionadas. Las colecciones pueden hacer que el desarrollo de conectores personalizados sea más rápido y sencillo si todavía no tiene una definición de OpenAPI para la API. Para obtener más información sobre las colecciones, vea Crear colecciones en la documentación de Postman.

En este tema, crea una colección que incluye una solicitud y una respuesta de la API Text Analytics de Cognitive Services. En un tema relacionado, crea un conector con esta colección.

Requisitos previos

• La aplicación Postman
• Una clave de API para la API de Text Analytics de Cognitive Services

Crear una solicitud HTTP para la API

1. En Postman, en la pestaña Builder (Generador), seleccione el método HTTP, escriba la dirección URL de solicitud para el punto de conexión de API y seleccione un protocolo de autorización, si es aplicable.

   

   Parámetro	valor
   Método HTTP	"POST"
   Solicitar URL	"https://westus.api.cognitive.microsoft.com/text/analytics/v2.0/sentiment"
   Autorización	"No Auth" (se especificará una clave de API en el paso siguiente)

2. Escriba los pares de clave-valor para el encabezado de la solicitud. Para los encabezados HTTP comunes, puede seleccionar en la lista desplegable.

   

   Tecla	valor
   Ocp-Apim-Subscription-Key	su-clave-de-suscripción-API, que encontrará en la cuenta de Cognitive Services
   Tipo de contenido	"application/json"

3. Escriba el contenido que quiera enviar en el cuerpo de la solicitud. Para comprobar que la solicitud funciona mediante la obtención de una respuesta de vuelta, elija Send (Enviar).

   

   {
       "documents": [{
           "language": "en-us",
           "id": "1", 
           "text": "I enjoyed the new movie after a long day."
       }]
   }
   

   El campo de respuesta incluye la respuesta completa de la API, incluido el resultado o un error, si se produjo uno.

   

Para obtener más información sobre las solicitudes HTTP, vea Solicitudes en la documentación de Postman.

Guardar la colección

1. Seleccione Guardar.

   

2. En Save Request (Guardar solicitud), proporcione un nombre de solicitud y una descripción de la solicitud. El conector personalizado usa estos valores para el resumen y la descripción de la operación de la API.

   

   Parámetro	valor
   Nombre de solicitud	"DetectSentiment"
   Descripción de solicitud	"La API devuelve una puntuación numérica comprendida entre 0 y 1. Las puntuaciones cercanas a 1 indican una opinión positiva, mientras que las puntuaciones cercanas a 0 indican una opinión negativa".

3. Elija + Crear colección y póngale un nombre a la colección. El conector personalizado usa este valor cuando se llama a la API. Elija la marca de verificación, que crea una carpeta de colección, y elija a continuación Save to SentimentDemo (Guardar en SentimentDemo).

   

   Parámetro	valor
   Nombre de colección	"SentimentDemo"

Guardar la respuesta de solicitud

Ahora que ha guardado la solicitud, puede guardar la respuesta. De este modo, la respuesta aparece como un ejemplo al cargar la solicitud más tarde.

1. Encima de la ventana de la respuesta, elija Save Response (Guardar respuesta).

   

   Los conectores personalizados solo admiten una respuesta por solicitud. Si guarda varias respuestas por solicitud, solo se usa la primera de ellas.

2. En la parte superior de la aplicación, proporcione un nombre para la respuesta de ejemplo y elija Save Example (Guardar ejemplo).

   

Si la API tuviera características adicionales, seguiría creando la colección de Postman con todas las solicitudes y respuestas adicionales.

Exportar la colección de Postman

Ahora puede exportar la colección como un archivo JSON, que importará mediante el asistente de conector personalizado. Antes de exportar la colección, quite el tipo de contenido y los encabezados de seguridad, que eran necesarios para realizar solicitudes de API, pero que se tratan de forma diferente en el conector personalizado.

1. En Encabezados, mantenga el puntero sobre cada encabezado y elija la X situada junto al encabezado para quitarlo. Elija Save (Guardar) para volver a guardar la colección.

   

2. Elija los puntos suspensivos (. . . .) situados junto a la colección y, después, elija Exportar.

   

3. Elija el formato de exportación Collection v1 (Colección v1), elija Export (Exportar) y vaya a la ubicación en la que desea guardar el archivo JSON.

   

   Nota

   Actualmente, solo puede usar colecciones v1 para conectores personalizados.

Pasos siguientes

Ahora está listo para definir un conector personalizado basado en la colección Postman que creó:

• Creación de un conector personalizado a partir de una colección de Postman