Cómo crear y administrar APIs y microservicios en WSO2

En esta pequeña guía Vamos a explicar que es la herramienta, un ejemplo de caso de uso donde podríamos aplicarla, como descargarla, instalarla, crear roles, usuarios, definir un par de APIs y ver algunas funcionalidades relevantes de gestión y reportes.

1- ¿Que es WSO2?

Es un un enfoque de código abierto para abordar cualquier espectro del ciclo de vida de las APIs como lo son la monetización, monitoreo, aplicación de políticas de seguridad, versionado y un largo etc. A modo de curiosidad aunque en si sitio web no lo he encontrado en algunas otras fuentes he leído que sus siglas significan Web Service Oxigenate.

En un plano mas tangible es una marca que nos ofrece una serie de productos o herramientas open source con las cuales podremos crear, gestionar y mantener todas las interfaces mediante las cuales se ofrecen los servicios de la compañía (APIs) bien de manera interna a otras áreas de la compañía o bien de manera externa a terceros que les pueda interesar la información o funcionalidad que ofrecen los servicios de nuestra compañía.

Una de las aplicaciones más comunes en el ámbito empresarial podría ser la creación de un marketplace para ofrecer software como servicios por ejemplo (SaaS), dichos servicios dependerán mucho del modelo de negocio de cada compañía

Para dar un ejemplo podríamos citar una central de riesgos como la RAI (Registro de Aceptaciones Impagadas)en España o datacrédito en Colombia en las cuales se almacena la información referente al historial crediticio de la personas y luego estas ofrecen dicha información a las entidades que lo requieren para su proceso de conoce a tu cliente (Know Your Customer), que se da al momento en que una persona solicita algún tipo de servicio postpago como los son productos financieros como tarjetas de crédito, créditos de consumo, servicios de suscripción a telefonía, televisión etc y el prestador de servicios realiza un estudio antes de otorgar el servicio con el fin de disminuir y gestionar los riesgos por impagos.

En este caso de uso, estas entidades podrían crear un par de servicios al cual se acceda mediante autenticación para obtener la información básica de una persona, y otro donde ofrezcan información mas concreta como cantidad de créditos abiertos, reportes de morosidad entre otros y se cobre por cada consulta o por un numero concreto de consultas mensuales por ejemplo, incluso este servicio algunas entidades lo ofrecen al publico en general que quiere conocer su reporte financiero antes de solicitar creditos por ejemplo.

Pero este es solo un pequeñísimo ejemplo de la cantidad de aplicaciones que ofrecen los micro servicios y el API Management a las compañías en un mundo cada vez mas globalizado, descentralizado y abierto.

2- Descarga, Instalación y configuración

• Acceder al sitio web oficial https://wso2.com

• Enterar en el apartado de API Manager

• Pulsar en el botón descargar

• Elegir la opción de acuerdo al sistema operativo

• Luego aparecen dos opciones una donde debemos registrarnos y se requiere un correo corporativo y otra donde solo con ingresar un correo personal podremos acceder a la descarga.

Continuación el paso a paso en imágenes:

Una vez descargado el archivo procederemos a instalarlo lo cual varía de acuerdo al SO.

En sistema windows basta con descomprimir el zip en el sitio que deseemos establecer el home del producto. En un sistema linux debemos instalarlo como un paquete mas, en los SO basados en debían como ubuntu por ejemplo lo haremos de la siguiente manera:

sudo dpkg -i 'rutalcompleta/012019/API MANAGMENT/wso2am-linux-installer-x64-2.6.0.deb'

con esto se creara un directorio en la carpeta de usuario por defecto la cual se conocerá como la carpeta home del producto, la ruta sera: /usr/lib/wso2/wso2am/2.6.0/

Dentro de este directorio los subdirectorios mas interesantes para iniciar son el /usr/lib/wso2/wso2am/2.6.0/binary donde están los ejecutables y /usr/lib/wso2/wso2am/2.6.0/repository/logs/ donde veremos los logs para poder diagnosticar si todo va bien o se presentan errores en la ejecución.

Si todo ha ido bien en la instalación estaremos casi listos para iniciar el servicio y empezar a trabajar, solo tendremos pendiente asegurarnos de configurar correctamente la variable de entorno JAVA_HOME dado que es un pre-requisito del producto.

1. En linux utilizaremos el comando ~$ ls -l `which java` para conocer la ruta donde esta instalado nuestro Java.

2. El comando anterior nos mostrara una ruta de enlace simbólico como este /usr/bin/java -> /etc/alternatives/java y deberemos usar el comando ls -lha /etc/alternatives/java el cual nos indicara la ruta absoluta donde esta instalado Java en nuestro sistema operativo. En mi caso /usr/lib/jvm/java-8-openjdk-amd64/jre/bin/java

3. Una vez conocemos esta ruta, debemos establecer la variable JAVA_HOME en el fichero de inicio para todos los usuarios, para ello editamos el fichero /etc/profile usando el editor preferido, en mi caso utilizaré nano. sudo nano /etc/profile

4. Luego al final agregamos las siguientes lineas (fíjate primero que no las tengas ya definidas porque esto las sobrescribirá y además asegurate de que la ruta del Java es la correcta en tu maquina). export JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64export PATH=${JAVA_HOME}/bin:${PATH}

5. Por ultimo hacemos un reload del fichero profile source /etc/profile y validamos que haya quedado bien con el comando ~$ echo $JAVA_HOME lo cual nos mostrara algo como esto /usr/lib/jvm/java-8-openjdk-amd64

En un sistema operativo windows se realiza de manera gráfica y es bastante sencillo no explicaré en este tutorial, si lo requieren me lo pueden dejar en los comentarios y agregaré un post para ello.

En este punto ya estaremos listos para iniciar el servicio, para ello nos vamos al subdirectorio bin

~$ cd /usr/lib/wso2/wso2am/2.6.0/

y buscamos el fichero wso2serve con la extensión .sh si estamos en linux o .bat si estamos en windows.

y lo ejecutamos pasandole el parámetro de start, en linux será ./wso2serve.sh start, esperamos un par de minutos mientras termina de iniciar todos los servicios, si no inicia correctamente deberemos revisar en el log /usr/lib/wso2/wso2am/2.6.0/repository/logs/wso2carbon.log los posibles errores y revisar de nuevo la configuración previa, lo mas probable es que la variable JAVA_HOME haya quedado mal definida.

Si por el contrario todo ha ido bien, deberíamos ver algo como la siguiente imagen y podríamos acceder a la carbón (consola de administración) mediante un navegador con la siguiente url https://localhost:9443/carbon nos pedirá un usuario y contraseña, utilizaremos el por defecto admin en ambos campos.

3 Inicio del servicio

Una vez en la consola de administración tendremos varias opciones, lo primero que vamos a realizar es la creación de un par de roles y un par de usuarios para empezar a trabajar.

4. creación de usuarios y roles

En nuestro caso vamos a crear un role internos llamado creators al cual le concederemos los privilegios necesarios para ingresar y gestionar las APIs y en el agruparemos todos los usuarios de la compañía que puedan realizar estas tareas y luego crearemos otro role externo llamado suscriber al cual solo le daremos privilegios para suscribirse a nuestras apis y en el agruparemos los usuarios que vayan a consumir nuestras APIs. el proceso se detalla a continuación: