Pruebe las API con el Portal de API en Jitterbit API Manager

Introducción

El Portal de API proporciona documentación interactiva de OpenAPI para que los usuarios prueben sus API personalizadas, proxy y OData. Esta interfaz, construida sobre las especificaciones de OpenAPI 2.0, permite a los desarrolladores comprender la funcionalidad de la API, probar los puntos finales y ver ejemplos de respuestas. Los administradores pueden gestionar la documentación de OpenAPI desde la página del Portal Manager o desde la pestaña de Documentación al editar una API individual en la página de APIs.

Acceder al Portal de API

Requisitos previos

Antes de acceder a la página del Portal de API, asegúrese de cumplir con los siguientes requisitos:

• Permisos de usuario: Debe pertenecer a un rol de organización que haya recibido un mínimo de acceso Lectura en el entorno de la API.

• Configuración de API: Las API deben tener roles de usuario apropiados asignados. Para más información, consulte la documentación de configuración para API personalizadas y API proxy.

• Documentación publicada: La documentación de la API debe generarse y publicarse a través del Portal Manager o la pestaña de Documentación al editar una API individual en la página de APIs.

Métodos de acceso

Puede acceder a la página del Portal de API a través de cualquiera de los siguientes métodos:

• Utilice el menú del portal de Harmony para seleccionar API Manager > Portal de API.

• Los consumidores de la API con permisos de ApiConsumer pueden acceder al portal a través de un enlace directo. Puedes obtener un enlace directo desde estas ubicaciones:

  • Copia la URL de la página del Portal de API.

  • Usa el enlace Ver Documentación de API desde la página del Administrador del Portal.

  Al acceder al enlace directo del Portal de API, si los usuarios no han iniciado sesión, se les presenta una página de inicio de sesión genérica que es diferente de la página de inicio de sesión del portal de Harmony. Aunque la página de inicio de sesión se ve diferente de la del portal de Harmony, las credenciales requeridas son las mismas que las utilizadas para iniciar sesión en el portal de Harmony.

  Después de iniciar sesión, se muestra la página del Portal de API.

• Los administradores de la organización pueden invitar a usuarios a través de la página de Gestión de Usuarios del Consola de Administración Gestión de Usuarios.

Navegar por la interfaz

Encabezado de la página del Portal de API

El encabezado del portal muestra la siguiente información y controles:

• Organización: Nombre de la organización actual, por ejemplo, Jitterbit.

• URL Base: La URL base de las APIs en la organización.

  • Copiar: Haz clic para copiar la URL base en tu portapapeles.

• Buscar: Ingresa un nombre de API, nombre de servicio o método para filtrar las APIs Disponibles a aquellas que coincidan con la consulta.

Barra lateral de API

La barra lateral izquierda organiza tus APIs por grupo basado en la raíz del servicio:

• APIs Disponibles: Muestra los servicios de API. Usa Expandir/Colapsar todo para mostrar u ocultar la lista de APIs.

  • Vista de usuario interno: Las APIs están agrupadas por raíz de servicio, por ejemplo, pet o store. Cuando expandes un grupo, ves el nombre descriptivo del servicio, como Encontrar mascota por ID o Agregar una nueva mascota a la tienda.

  • Vista de usuario externo: Las API se agrupan por raíz de servicio, por ejemplo, pet o store. Cuando expandes un grupo, ves las rutas completas de los endpoints, como /defaultUrlPrefix/1/uploadImage o /defaultUrlPrefix/deletePet.

Probar APIs

Cuando seleccionas un endpoint de API, su documentación interactiva de Swagger UI se muestra en el lado derecho de la página. Puedes usar el Swagger interactivo para probar los servicios de API:

• Autorizar: Si alguna de las API dentro del entorno seleccionado requiere una autorización establecida por un perfil de seguridad asignado, se muestra un botón de Autorizar. Cuando haces clic en Autorizar, se muestra un diálogo con las autorizaciones disponibles. Completa la entrada según sea necesario para probar las API con los métodos de autorización proporcionados.

  Al hacer clic en Autorizar, se muestra un diálogo con las autorizaciones disponibles. Completa la entrada según sea necesario para probar las API con los métodos de autorización proporcionados:

  

  El ícono de autorización indica si el servicio de API requiere autorización:

  • : No se requiere autorización.
  • : Se requiere autorización.

• Pruébalo: Haz clic para probar la API. Se expande una solicitud de API configurable:

  

  • Cancelar: Haz clic para colapsar la solicitud de API configurable.

  • Ejecutar: Después de que se configuren los campos de solicitud, haz clic para generar el Curl y la URL de solicitud que se utilizarán para la prueba:

    

  • Curl: La solicitud cURL para los valores ingresados en los campos de solicitud de la API. Haz clic en el ícono para copiar el cURL en tu portapapeles.

  • Request URL: La URL de solicitud para los valores ingresados en los campos de solicitud.

  • Clear: Haz clic para limpiar los valores ingresados en los campos de solicitud de la API.

Cada servicio de API muestra posibles respuestas de API que están incluidas en la documentación de la API:

• Server response: Muestra cualquier respuesta de servidor documentada.

• Responses: Muestra los códigos de estado HTTP documentados y sus descripciones.