SAP API Management en HCP
Primeros pasos
Podemos encontrar numerosos ejemplos de como crear un API a partir de un servicio OData (Por ejemplo:
How to use SAP API Management on HCP trial) pero aquí voy a explicar como podemos crear un API a partir de un servicio REST cualquiera.
Entendiendo el servicio
El servicio SAP API Management necesita un servicio accesible desde web, en concreto SAP nos dice que soporta servicios OData, REST y SOAP. Todos estos servicios tienen una cosa en común, son accesibles mediante una llamada de este tipo:
HTTP(s)://servidor:puerto/prefijo/base/recurso
Por ejemplo, para el servicio de "address cleansing" (
del que ya he hablado en este blog) tenemos la siguiente URL:
HTTPS://dqaasu23133c2f-<consumeraccount>.hanatrial.ondemand.com/dq/addressCleanse
Donde:
- servidor = dqaasu23133c2f-<consumeraccount>.hanatrial.ondemand.com
- puerto = 443 (es el puerto por defecto para conexiones HTTPS a si que no hace falta indicarlo)
- prefijo, ninguno, en este caso no tenemos prefijo
- base = dq
- recurso = addressCleanse
La idea es que servidor+puerto+prefijo es el lugar donde están TODAS las APIs de un determinado proveedor, y base+recurso es donde accedemos a cada API de forma individual. Siguiendo con el ejemplo del servicio de SAP para data quality, tenemos dos APIs:
- Address Cleansing: https://dqaasu23133c2f-<consumeraccount>.hanatrial.ondemand.com/dq/addressCleanse
- Reverse Geocode: https://dqaasu23133c2f-<consumeraccount>.hanatrial.ondemand.com/dq/reverseGeo
Las dos están en https://dqaasu23133c2f-<consumeraccount>.hanatrial.ondemand.com, y la forma de acceder a cada una de ellas es: /dq/addressCleanse y /dq/reverseGeo
Evidentemente podríamos haver considerado que "/dq" es el prefijo y que lo que está vacío es la base, o incluso que la base es "addressCleanse" y lo que está vacío es el recurso, pero cuando estemos creando el proxy en HCP veremos que lo que yo planteo es más cómodo.
¿Qué hace SAP con estos servicios OData, REST o SOAP? pues crea para ellos un proxy del tipo:
https://trial.apim1.hanatrial.ondemand.com:443/<cuentaHCP>/base
Donde "base" es la "base" de nuestro servicio original (Por eso la base no puede estar vacía y es obligatoria) y cada proxy tendrá varias APIs, tantas como recursos definamos (y por lo tanto el recurso no puede estar vacío)
Este proxy es el que se encargará de la gestión de cuotas de uso, seguridad, control de errores, etc.
Creación de un proxy
Una vez configurado el servicio (aquí, en la sección 1, explican como hacerlo con mucho detalle:
Building & Consuming API's using SAP API Management (Part 1)) lanzamos el API Portal:
Y desde el API Portal, lanzamos la utilidad de crear API Providers:
Podemos considerar el API provider como el servidor donde se encuentran los servicios para los que queremos crear un API. En este ejemplo usaremos los Data Quality Microservices de SAP:
En el borrón negro va el usuario HCP, cada uno tiene que usar el suyo.
Abajo a la izquierda encontramos el botón de guardar (Save)
El paso siguiente es crear el API Proxy:
Estamos indicando, dentro del servidor creado en el paso anterior, en que URL están los servicios, en nuestro caso esa URL es dq. Pulsamos en "Create" y vamos a por la última parte. Crear los "resources" que, por fin, son la API propiamente dicha:
Y al pulsar en "Add" tenemos creado el recurso dentro de nuestro proxy:
Para añadir mas "resources" solo tenemos que volver a pulsar en "Add". Para guardar nuestra API tenemos abajo a la derecha dos botones: "Sava As Draft", que guarda la configuración pero no la crea en el HCP, y "Save And Deploy", que guarda la configuración y crea el proxy en HCP. Importante, hasta que no hagamos el deploy no existirá nuestra API.
Una vez realizado el deploy, llega el momento de probar nuestro trabajo:
En este caso estoy usando los datos de ejemplo de mi artículo sobre el microservicio de calidad de datos. Para poder incluir parámetros en la cabecera tenemos que pulsar el botón "Headers". Una vez que tengamos todos los datos de test solo tenemos que pulsar en botón que tenemos en la parte de abajo a la derecha "Send" para poder ver el resultado de la llamada a nuestra API:
Añadiendo funcionalidad al API proxy
Ahora mismo nuestro proxy no aporta nada más que un entorno de test para el servicio REST, pero para poder aprovechar realmente el potencial de SAP API Management tenemos que usar las "Policies":
Las "Policies" (políticas o normas) nos van a permitir a realizar acciones sobre el mensaje ANTES de que la llamada llegue al servicio (PreFlow) o DESPUES de la ejecución del servicio (PostFlow). Como ejemplo vamos a añadir la regla de que se verifique la clave de API (API Key) es decir, que para usar nuestra api tenga que existir una suscripción a la misma en el servicio de HCP:
Para facilitar los ejemplos en este Blog, he cambiado el script para que la API Key se lea de la cabecera: "<APIKey ref='request.header.APIKey'/>"
Pulsamos en "Update" abajo a la derecha y ya tenemos nuestra "Policie" añadida. Importante pulsar en "Save" en la pantalla de la API, o de lo contrario perderemos nuestra "Poicie".
Al añadir esta regla, no podremos volver a probar nuestro API en el portal de APIs (API Portal) ya que nos dará el error de que falta el APIKey.
Publicar el API
Nuestros API los creamos para que puedan ser consumidos desde el portal de Gestión de desarrollos (Dev Portal). Para que esto sea posible tenemos que crear un "Product"
Después de todo esto, pulsamos en "Publish" abajo a la derecha y ya tenemos listo nuestro producto para ser consumido desde el "Dev Portal".
Como esta entrada del Blog ya ha quedado demasiado larga, dejo la parte del "Dev Portal" para otro artículo.
