API7 Enterprise v3.3.0 es compatible con API Portal

Descripción general del Portal para Desarrolladores

El Portal para Desarrolladores es una plataforma dedicada diseñada para consumidores de API (por ejemplo, desarrolladores externos y equipos internos) que proporciona acceso unificado a la documentación de API, herramientas de prueba y recursos relacionados. Este portal no solo facilita a los desarrolladores la comprensión e integración rápida de las API, sino que también mejora las capacidades de visualización y control a nivel de gestión y seguridad. Para una plataforma de puerta de enlace de API, ofrecer un portal para desarrolladores permite lo siguiente:

1. Exposición simplificada de API: Al consolidar documentación fragmentada, ejemplos y especificaciones de interfaz en una plataforma unificada, el portal reduce significativamente los costos de integración y acelera la integración del producto con sistemas externos.

2. Mejora de la eficiencia en I+D y operaciones: Funciones de autoservicio como la búsqueda de documentación, pruebas y depuración reducen la comunicación repetitiva y el mantenimiento de la documentación, mejorando así la eficiencia general.

3. Gestión y monitoreo centralizados: La plataforma proporciona un mejor seguimiento del uso de API, análisis de respuestas y monitoreo de métricas clave, junto con la detección temprana de posibles problemas.

En API7 Enterprise 3.3.0, API7 Gateway ahora admite la generación automática de un portal para desarrolladores directamente desde la documentación de API proporcionada por el usuario. Esta capacidad permite a las organizaciones exponer más fácilmente los recursos de API a partes externas, al mismo tiempo que ofrece una experiencia consistente y conveniente para los desarrolladores.

Portal de Proveedores API7 y Portal para Desarrolladores

Como plataformas de gestión de API, el Portal de Proveedores API7 y el Portal para Desarrolladores desempeñan roles complementarios, pero atienden a diferentes audiencias y funcionalidades.

Portal de Proveedores API7

El Portal de Proveedores API7 es una consola de gestión diseñada para proveedores de API, facilitando la gestión del ciclo de vida de las API con facilidad.

• Audiencia objetivo: Proveedores y administradores de API.
• Funciones principales:
  • Publicación y gestión de productos de API.
  • Gestión de desarrolladores.
  • Configuración de políticas para el acceso al Portal para Desarrolladores, como la visualización anónima de API y métodos de inicio de sesión.
  • Visualización de estadísticas de acceso a API, realización de análisis y seguimiento de registros.

Portal para Desarrolladores API7

El Portal para Desarrolladores API7 proporciona un punto de entrada unificado y de autoservicio para desarrolladores o socios, permitiéndoles comprender, acceder y utilizar rápidamente los servicios de API.

• Audiencia objetivo: Consumidores de API, como desarrolladores externos, socios o equipos de desarrollo internos.
• Funciones principales:
  • Proporcionar documentación de API, guías de uso y código de ejemplo.
  • Ofrecer interfaces de prueba y depuración en línea.
  • Gestionar el registro de aplicaciones, obtener claves de API y manejar credenciales de autenticación.

Cómo usar el Portal API7

Acceso al Portal de Proveedores API7

Después de iniciar sesión en el panel de control de API7 Enterprise, los usuarios son dirigidos a la página de gestión de Gateway por defecto. Para cambiar al Portal de Proveedores API7, haga clic en el botón de alternar en la esquina superior izquierda. Al cambiar, el título de la página se actualiza a Portal de Proveedores API7, y el menú de la izquierda refleja las opciones relevantes para la gestión de productos de API.

Creación y publicación de productos de API

Los productos de API son un recurso central en el Portal de Proveedores API7, representando un grupo de API relacionadas. Los desarrolladores suelen suscribirse a las API a nivel de producto. Hay dos métodos para crear productos de API.

1. Basado en servicios publicados en API7 Gateway

• Seleccione servicios publicados existentes en API7 Gateway y agrúpelos en un producto de API.
• Dentro del producto de API, cada ruta correspondiente a un servicio se trata como una API independiente.

2. Importación de archivos OpenAPI

• Genere rápidamente productos de API importando archivos OpenAPI existentes.
• Tenga en cuenta que los productos creados de esta manera no están directamente vinculados a las configuraciones del gateway.

Ejemplo: Agregar un producto de API desde API7 Gateway

Para agregar un producto de API, haga clic en el botón "Agregar producto de API" y seleccione el elemento de menú "Desde API7 Gateway" para acceder al formulario de creación de productos de API.

En el formulario, debe completar la siguiente información:

1. Básicos: Incluye nombre, descripción, etiquetas, logotipo, etc.

2. Tipo de autenticación: Especifique si se requiere aprobación.

3. Visibilidad: Establezca el alcance de visibilidad del producto de API.

4. Servicios de Gateway vinculados: Seleccione un servicio de gateway publicado que cumpla con las siguientes dos condiciones:

   • Se ha configurado un nombre de host.
   • Se ha cargado un documento OpenAPI.

Agregar un nuevo producto de API

Si no hay servicios que cumplan los requisitos, puede seguir los pasos de configuración a continuación.

1. Cargar documento OpenAPI y configurar nombre de host para servicios existentes

En la página de detalles del servicio o plantilla de servicio, haga clic en Especificación OpenAPI en la barra de navegación izquierda. Luego, cargue el documento OpenAPI correspondiente para el servicio. Asegúrese de que las definiciones de API en el documento coincidan exactamente con las rutas reales del servicio. Esto garantiza que los desarrolladores obtengan documentación precisa de la API durante la depuración y un acceso exitoso al upstream.

Después de cargar el documento, puede previsualizarlo en tiempo real, lo que refleja la documentación final de la API que los desarrolladores verán.

A continuación, en la sección Rutas de la página de detalles del servicio o plantilla, configure los hosts en el módulo URL de solicitud. Por defecto, los hosts están configurados como "*", lo que significa que el servicio procesa solicitudes de cualquier nombre de host.

Para vincular el servicio a un producto de API, se debe especificar un host preciso. Este requisito asegura que los desarrolladores puedan acceder a las API utilizando el formato de ruta completo: host + prefijo de ruta + API.

2. Crear un nuevo servicio para vincular a un producto de API

Si no se han publicado servicios, puede crear un nuevo servicio cargando un documento OpenAPI como plantilla de servicio y publicándolo, o creando un servicio directamente en el grupo de gateway. Los servicios creados de esta manera analizan automáticamente las API definidas en OpenAPI en rutas, conservando el documento sin necesidad de volver a cargarlo. Configure el host como se describió anteriormente para que el servicio sea elegible para la vinculación con productos de API.

Una vez completada la configuración del gateway, regrese al portal de proveedores y haga clic en Agregar servicio de gateway vinculado. Seleccione el servicio publicado requerido para completar la vinculación.

Por defecto, el producto de API recién creado estará en estado de borrador, invisible para los desarrolladores. Antes de publicar, revise la documentación de la API, la configuración de visibilidad y la configuración de autenticación. Se recomienda configurar notificaciones de eventos de productos de API (por ejemplo, aprobación o cancelación de suscripción) para evitar perder actualizaciones críticas.

Publicar un producto de API

Después de verificar el producto de API, haga clic en el botón Publicar en la esquina superior derecha y confirme. Los desarrolladores que coincidan con la configuración de visibilidad podrán acceder al producto a través del Portal para Desarrolladores.

Acceso al Portal para Desarrolladores API7

Puede acceder al Portal para Desarrolladores API7 de dos maneras:

1. Visite la URL del Portal para Desarrolladores.
2. Haga clic en el botón Portal para Desarrolladores en el menú izquierdo del panel de control del Portal API7.

En la página de inicio del Portal para Desarrolladores API7, haga clic en el botón Iniciar sesión en la esquina superior derecha para iniciar sesión.

Crear un desarrollador

Hay dos formas de crear una cuenta de desarrollador:

• Autoregistro: Los desarrolladores se registran ellos mismos en la página de inicio de sesión.
• Invitación del administrador: Los administradores crean cuentas a través del panel de control del Portal API7.

Autoregistro

Haga clic en el botón Registrarse en la página de inicio de sesión y complete el formulario con un nombre de usuario y contraseña.

Registro iniciado por el administrador

En el panel de control del Portal API7, navegue a la sección Desarrolladores y haga clic en Invitar desarrollador. Complete el formulario con el nombre de usuario y una contraseña de un solo uso, y opcionalmente proporcione un nombre para mostrar para identificación.

Después de agregar al desarrollador, comparta el nombre de usuario y la contraseña con el usuario. En el primer inicio de sesión, deben restablecer su contraseña.

Ver productos de API

Después de iniciar sesión, los desarrolladores pueden hacer clic en API Hub para ver todos los productos de API publicados.

Además de ver la documentación de la API, el sistema también admite la generación de muestras de código en varios idiomas para cada API en la página de detalles. Los desarrolladores pueden copiar estos códigos de muestra en su entorno de desarrollo para realizar pruebas.

Depuración de productos de API

Además, los desarrolladores pueden probar las API directamente haciendo clic en el botón Probar solicitud.

Después de hacer clic en Probar solicitud, puede ver un panel de prueba en línea.

• La URL de solicitud se genera automáticamente en función de la configuración del servicio asociado con el producto de API.
• El Método de autenticación por defecto es Key Auth y se rellena automáticamente con la clave de API de la cuenta de desarrollador actual.

Los desarrolladores solo necesitan complementar los parámetros de solicitud requeridos según la definición de la interfaz de API para proceder con la depuración.

Suscripción a productos de API

Si un producto de API está restringido a usuarios específicos, el administrador del portal de proveedores puede desactivar la opción Los desarrolladores no suscritos pueden ver los detalles de la API en la configuración de visibilidad del producto. Esto asegura que los desarrolladores deben suscribirse al producto antes de acceder o invocar sus API.

Cuando un desarrollador accede a la página de detalles del producto de API bajo esta configuración, se mostrará un botón "Suscribirse para desbloquear". Al hacer clic en el botón, se envía una solicitud de suscripción al administrador del proveedor.

Si el proceso de aprobación está habilitado para el producto de API, el desarrollador debe esperar la aprobación del administrador antes de obtener acceso para ver los detalles.

En el menú Organización del Portal de Proveedores API7, si hay aprobaciones pendientes, aparecerá un punto rojo junto al elemento de menú Aprobaciones como indicador. Al hacer clic en este elemento de menú, se navega a la página de gestión de aprobaciones.

La página de aprobaciones está diseñada para gestionar las solicitudes de los desarrolladores para acceder a los recursos de API. Los administradores pueden revisar la siguiente información de solicitud en esta página: tipo de evento, nombre del recurso, solicitante y hora de solicitud. A través de la interfaz, los administradores pueden tomar acciones para Aprobar o Rechazar la solicitud.

La decisión de aprobación afecta directamente los permisos de acceso a la API del desarrollador:

• Aprobar: El desarrollador obtiene acceso para ver la página de detalles del producto de API e invocar la API.
• Rechazar: El desarrollador debe comunicarse con el administrador, realizar los ajustes necesarios según los comentarios y volver a enviar la solicitud.

Conclusión

API7 Enterprise integra la plataforma de puerta de enlace de API con un portal para desarrolladores para crear una solución eficiente de gestión de API tanto para proveedores como para desarrolladores.

El Portal de Proveedores API7 permite a los proveedores de API publicar, gestionar y monitorear fácilmente los productos de API mientras coordinan eficazmente los recursos de los desarrolladores. Mientras tanto, los desarrolladores pueden comprender, integrar y utilizar eficientemente los servicios de API, acelerando el desarrollo de aplicaciones. Estos dos portales trabajan en sinergia para simplificar el proceso de gestión del ciclo de vida de las API, haciendo que cada paso, desde la implementación hasta la invocación, sea más fluido y eficiente.