Creación y gestión de portales para desarrolladores con APIG

¿Qué es un Portal para Desarrolladores?

Un portal para desarrolladores es una herramienta clave para aquellos que quieren consumir tus APIs. En el contexto dado, estamos hablando de un Developer Portal, el cual está diseñado para proporcionar a los desarrolladores de aplicaciones una experiencia de integración de autoservicio. Esto significa que podrán fácilmente explorar tu catálogo de APIs, revisando su documentación, e incluso registrarse para comenzar a integrarlas en sus proyectos.

¿Cuáles son las funcionalidades de un Developer Portal?

• Exposición de APIs: Las APIs que desees compartir estarán disponibles en el portal, con toda su documentación.
• Control de acceso: Puedes definir quién puede ver y utilizar cada API que estás exponiendo.
• Interfaz web: Los desarrolladores pueden interactuar con tus APIs a través de una interfaz amigable.
• Prueba funcionalidad: Se permite a los desarrolladores registrar sus aplicaciones y probar cómo integrar tus APIs.

¿Cómo se realiza una actualización de API Proxy?

Una API Proxy actúa como una interfaz entre el cliente que consume APIs y el servicio real proporcionado. En este contexto, se está realizando una actualización de la Platzi Products API a través de APIG. Aquí se describen algunos pasos importantes que se deben seguir:

1. Subida de nueva revisión: Primero, se selecciona un archivo comprimido (ZIP) con la nueva definición de CORS (Cross-Origin Resource Sharing).
2. Configuración de Base Path: Es fundamental ajustar el base path en el código para asegurar que la API funcione correctamente.
3. Verificación de API Key: Se debe verificar que el nombre de la API Key sea consistente en todo el flujo de trabajo.
4. Despliegue en entorno de prueba: Finalmente, se debe desplegar la nueva revisión en el ambiente de pruebas y verificar su correcto funcionamiento.

¿Cómo se actualizan las especificaciones de la API?

Las especificaciones de la API te permitirán definir cómo es y opera tu API. En el escenario descrito, se realizaron los siguientes cambios:

• Ajuste de Base Path: Al igual que en la API Proxy, el base path debe coincidir con lo definido en la especificación.
• Definiciones de seguridad: Se añade una nueva sección llamada Security Definitions para gestionar el acceso.
• Protocolo HTTPS: Es recomendable cambiar de HTTP a HTTPS para mayor seguridad.

Es importante realizar estos cambios cuidadosamente y verificar la sintaxis para evitar errores.

¿Cómo se crea el Portal de Desarrolladores?

Una vez que tienes listas tus APIs, el siguiente paso es crear un entorno donde los desarrolladores puedan interactuar con ellas: el portal.

1. Creación del Portal: Iniciando desde la sección Publish, se crea un nuevo portal.
2. Personalización: Cabe la posibilidad de cambiar el tema, íconos, y el look and feel del portal, para que los usuarios se sientan más conectados.
3. Integración de APIs: Se añade la API Platzi Product al catálogo del portal.
4. Configuración detallada: Aspectos como el título, la descripción y restricciones a solo usuarios registrados se pueden definir.
5. Prueba del Portal: Antes de su exposición definitiva, es esencial registrarse y verificar la experiencia tal como lo harán los futuros usuarios.

Este proceso no solo permite a los desarrolladores acceder a tus APIs, sino que también mejora la percepción y usabilidad de tu ecosistema ofreciendo una experiencia robusta y amigable.

Con estos pasos, no solo optimizas el acceso a tus APIs, sino que también fortaleces la relación con los desarrolladores ofreciendo un soporte integrado y accesible. ¡Anímate a seguir explorando y creando nuevas soluciones con APIs!