Exponer tus APIs de forma profesional requiere más que simplemente tenerlas funcionando. Necesitas un espacio donde los desarrolladores puedan conocer tu catálogo, consultar documentación y comenzar a integrar tus servicios en sus aplicaciones. Apigee ofrece una herramienta específica para esto: el Developer Portal, y aquí verás paso a paso cómo crearlo y configurarlo.
¿Qué es el Developer Portal y por qué lo necesitas?
El Developer Portal es una interfaz web que proporciona y administra una experiencia de integración de autoservicio para los desarrolladores que desean consumir tus APIs [01:00]. Como proveedor de APIs, tu cliente principal son los desarrolladores, y este portal está diseñado pensando en ellos.
Desde el portal, los desarrolladores pueden:
- Explorar el catálogo de APIs expuestas.
- Consultar la documentación de cada API.
- Registrarse y comenzar a probar las APIs.
- Entender cómo integrarlas en sus aplicaciones.
Además, como administrador puedes controlar la visibilidad de las APIs y el acceso a los diferentes API products [01:42]. Esto te permite decidir qué productos son públicos y cuáles están restringidos a usuarios registrados.
¿Cómo preparar tu API proxy antes de crear el portal?
Antes de construir el portal, es necesario asegurar que tu API proxy esté correctamente configurada. En la práctica se trabaja con la API plaziProducts, subiendo una nueva revisión que incorpora una definición de CORS (Cross-Origin Resource Sharing) [02:28]. Este mecanismo permite que tu API interactúe correctamente a través de distintos orígenes o medios.
¿Qué ajustes son necesarios en el proxy?
Al subir la nueva revisión, hay que verificar dos elementos críticos:
- El base path: se actualiza desde el post flow en la sección de código. Si no recuerdas cuál es, puedes consultarlo en la sección Overview del proxy [03:24].
- El nombre de la API key: la variable
verified api key debe coincidir exactamente con la referencia en el flujo. Si el nombre no coincide, la validación falla por completo [03:55].
Una vez guardada la revisión, se despliega en el ambiente de test seleccionando Deployment y confirmando el despliegue [04:28].
¿Cómo actualizar las especificaciones de la API?
Dentro de la sección Specs, se editan las especificaciones previamente importadas con tres cambios puntuales [04:48]:
- Agregar el base path correcto copiándolo desde Overview.
- Incluir una sección llamada Security Definitions justo después de Produces [05:42].
- Cambiar el esquema de HTTP a HTTPS [06:05].
El editor valida la sintaxis en tiempo real. Si aparece algún error, es importante revisarlo antes de guardar, porque una especificación con errores no funcionará correctamente.
¿Cómo crear y configurar el Developer Portal en Apigee?
Desde la sección Publish en Apigee, se accede a Portals para crear uno nuevo [06:38]. Al crear el portal se asigna un nombre y una descripción. Apigee aprovisiona automáticamente un portal web completo.
Una vez creado, el portal ofrece opciones para personalizar el tema, cambiar íconos y ajustar el look and feel con la identidad de tu organización [07:20]. Sin embargo, lo esencial es la funcionalidad.
¿Cómo agregar APIs al catálogo del portal?
Desde el API Catalog del portal [07:36]:
- Se agrega un API product existente, en este caso Platzi API product.
- Se marca como Published y se le asigna un título.
- Se configura para que solo los usuarios registrados puedan ver la API.
- Se añade una imagen representativa para mejorar la presentación visual.
- Se vincula la especificación actualizada, en este caso Platzi spec [08:38].
Al guardar, el portal queda listo. Para acceder al portal en vivo se usa el enlace de live portal. Los desarrolladores deben registrarse con un correo real, ya que el sistema envía un enlace de confirmación para validar el acceso [09:10]. Este correo no necesita ser el mismo con el que te registraste en Apigee.
Este flujo replica exactamente lo que sucederá cuando expongas el portal a tus usuarios reales: registro, validación y acceso al catálogo de APIs. Si ya llegaste hasta aquí, cuéntame qué te pareció el proceso de configuración y si encontraste algún detalle inesperado durante la creación de tu portal.
