Skip to main content

Cómo utilizar Postman

Puedes utilizar Postman para probar la API V3 de Alteryx Server.

Requisitos previos:

  • Postman debe estar instalado. Postman está disponible en  go.postman.co/home .

  • Debes tener una clave de API y el secreto de una API para probar la API de Server en Postman. Consulta la página de ayuda Roles de usuario y permisos para obtener más información.

Agregar una API a Postman

Para probar la API de Server, impórtala a Postman.

  • Primero, debes obtener el enlace que utilizarás para importar la API V3 de Server. Para encontrar este enlace, ve a la interfaz de usuario de Server, selecciona el ícono de signo de interrogación situado en la esquina superior derecha y, a continuación, Documentación de la API . Esto te llevará a la página de Swagger de API V3.

  • Anota la dirección de la documentación de la API que encontrarás en la página de Swagger.

    Note the address of the API documentation you find on the Swagger page. 

  1. En Postman, ve a  Colecciones y selecciona  Importar .

  2. Selecciona  Enlace e introduce la URL de la API de Server que anotaste en el paso dos . A continuación, haz clic en  Continuar .

  3. Ahora puedes ver la API V3 de Alteryx Server en la pestaña  Colecciones .

Configurar la autorización

Para poder enviar tus solicitudes, debes configurar la autorización en Postman.

  • Ve a  Collections y selecciona  Alteryx Server API V3 .

  • En la pestaña  Autenticación , selecciona  OAuth 2.0  como Tipo.

  • Configura el Token actual de la siguiente manera:

    AD273A073BE2399E360B94B3F9EB79C6.png

  1. En la sección  Configurar nuevo token , establece lo siguiente:

    1. De manera opcional, introduce un Nombre de token .

    2. En  Tipo de autorización , selecciona  Credenciales de cliente .

    3. En  URL de token de acceso , escribe el punto de conexión para el servidor de autenticación. Para averiguar el punto de conexión, ve a Swagger y busca URL de token . Si deseas obtener más información, visita la sección Cómo autenticar de la página de ayuda  Configuración y autorización de la API .Configuración y autorización de la API de Server

      Find the Token URL in Swagger.

      Ejemplo de la configuración final de token:

      How the API authorization looks like in Postman.

    4. En  Id. de cliente , introduce la  clave de acceso a la API . Se encuentra en Mi perfil, en la interfaz de usuario de Server.

    5. En  Secreto de cliente , ingresa la  clave secreta de la API . Se encuentra en Mi perfil, en la interfaz de usuario de Server.

    6. En  Autenticación de cliente , selecciona  Enviar como encabezado de autenticación básica .

  2. Selecciona  Obtener nuevo token de acceso .

Configurar el entorno

No te olvides de configurar los mismos valores en el  Entorno .

  1. Selecciona el ícono de ojo ubicado en la esquina superior derecha y, a continuación, en la sección Entorno, haz clic en Agregar .

  2. Ingresa el nombre de tu entorno.

  3. Introduce la misma URL base, la clave de la API y el mismo secreto de la API que en el paso cuatro de la sección Configurar la autorización.

  4. Ingresa la URL para el entorno. Puedes encontrarla en  Configuración del sistema de Alteryx  bajo el nombre de  Dirección base . Consulta el paso cuatro  de la sección Configurar la autorización.

  5. Selecciona Guardar .

Enviar solicitudes

Puedes probar la API de Server en Postman: autoriza o envía tus solicitudes, o explora los diferentes tipos de código en ellas.

Ejemplo

Imaginemos que quieres recuperar una lista de activos que son propiedad de un usuario.

  1. En primer lugar, necesitas conocer el Id. de usuario específico.

    1. Ve a  Colecciones y, a continuación, selecciona  API V3 de Alteryx Server .

    2. Selecciona  Usuarios y, después,  OBTENER en Buscar registros de usuario .

    3. En la pestaña  Parámetros , puedes utilizar los parámetros para buscar en todos los registros de usuario.

    4. Para enviar la solicitud, selecciona  Enviar . Obtendrás resultados basados en los parámetros introducidos.

    5. En los resultados, copia el Id. del usuario cuya lista de activos deseas recuperar.

  2. En una pestaña diferente, abre otra solicitud. Ve a  Usuarios y selecciona  {id} .

  3. Selecciona  OBTENER en Recuperar una lista completa de los activos que posee un usuario . Ingresa el Id. de usuario que obtuviste en la solicitud anterior para adquirir la lista de activos de este usuario.

EF76F0DE8E6C3302DC8217A5E26730F2.png

Nota

Cuando envíes una solicitud a través de Postman, no te olvides de autorizarla. Tienes dos opciones para autorizar tu solicitud:

  • En Tipo , selecciona OAuth2 y, a continuación, uno de los tokens disponibles.

  • En Tipo , selecciona Heredar autenticación principal . Se utilizará la autorización que configuraste para toda la colección.

En esta sección: