1. ¿Qué es un API?

El término API es una abreviatura de “Application Programming Interfaces”, que en

español significa interfaz de programación de aplicaciones. Es una colección de
operaciones, subrutinas, funciones, métodos de servicio que pone a disposición de los
consumidores para abstraer funcionalidad.

Una de las principales funciones de las API es poder facilitar el trabajo a los
desarrolladores y ahorrarles tiempo y dinero. Por ejemplo, si estás creando una
aplicación que es una tienda online, no necesitarás crear desde cero un sistema de
pagos u otro para verificar si hay stock disponible de un producto. Podrás utilizar la API
de un servicio de pago ya existente, por ejemplo, PayPal, y pedirle a tu distribuidor una
API que te permita saber el stock que ellos tienen.

Con ello, no será necesario tener que reinventar la rueda con cada servicio que se crea,
ya que podrás utilizar piezas o funciones que otros ya han creado. Supongamos que
cada tienda online tuviera su propio sistema de pago, para los usuarios normales es
mucho más cómodo poder hacerlo con los principales servicios que casi todos utilizan.

2. IBM API Connect

IBM API Connect es una solución de integración para APIs de nivel empresarial. Es una
herramienta integrada para API Management con todas las capacidades para manejar
el ciclo de vida de API

Desarrollar y escribir definiciones de API desde un entorno de desarrollo de

Create
API, y eventualmente agrupar estas API en productos consumibles e
 implementarlas en entornos de producción.
Aproveche la puerta de enlace API, las políticas de puerta de enlace y más
Secure
de su clase para administrar el acceso a sus API y sistemas de back-end.
Las estructuras de gobierno están integradas en todo el ciclo de vida de la
API, desde la administración de los permisos de visualización / edición de las
Manage API y los productos que se implementan, hasta la administración de lo que
los desarrolladores de aplicaciones pueden ver y suscribirse cuando se
implementan las API.
API Connect viene con un portal para desarrolladores avanzado que agiliza
el proceso de incorporación de desarrolladores de aplicaciones y puede
Socialize
personalizarse completamente según los estándares de marketing de una
organización.
Tanto los desarrolladores como los gerentes de productos reciben las
herramientas en API Connect para comprender sus patrones de tráfico de
Analyze
API, latencia, consumo y más para obtener información basada en datos en
sus iniciativas de API.
La monetización de la API permite a los editores facturar a los suscriptores
Monetize
que consumen API en su tienda de API store

3. Principales Componentes de IBM API Connect

Estos cuatro componentes se pueden implementar en una variedad de topologías

híbridas y de múltiples nubes. La infraestructura de API Connect puede ser desplegada
y gestionada por un equipo de IBM en un entorno de IBM Cloud, o puede ser
desplegada y gestionada por los clientes en su propio entorno dedicado o en la nube
de terceros.

⮚ API Manager
⮚ API Gateways
⮚ Developer Portal
⮚ Analytics

4. Componentes de IBM API Connect

4.1 API Connect Cloud Manager

El “API Connect Cloud Manager” se utiliza para administrar la nube local de API
Connect. El administrador de la nube usa esta interfaz de usuario para:

⮚ Crear “provider organizations” e invitar a los usuarios a actuar como

propietarios.
⮚ Crear y administrar roles de usuario y valores por default de roles.
⮚ Crear zonas de disponibilidad para servicios.
⮚ Registrar los servidores relevantes que proporcionarán los servicios de
gateway, análisis y portal.
⮚ Asociar un servicio de análisis con una gateway para habilitar informes para
eventos de API
 ⮚ Configurar los recursos para la autenticación de usuarios, la seguridad TLS y
los proveedores de OAuth y hacer que los recursos sean visibles para todas
las “provider organization” o para algunas de ellas.
⮚ Conectar a un servidor de correo SMTP existente y editar plantillas para
correos electrónicos generados por el sistema.
⮚ Establecer el servicio de gateway predeterminado para catálogos.

4.2 Developer Toolkit

El “Developer toolkit” proporciona las herramientas para modelar, desarrollar y

probar API y aplicaciones LoopBack. El Developer toolkit es instalado localmente
y permite desarrollar y modelar las API fuera de línea.

4.3 API Manager

El “API Manager” proporciona una interfaz de usuario que facilita la promoción y

el seguimiento de las API incluidas en Productos y planes. Los proveedores de
API pueden mover los Productos a lo largo de su ciclo de vida y administrar la
disponibilidad y visibilidad de API y Planes.

Los catálogos y espacios se crean en API Manager para que actúen como
destinos de prueba a través de los cuales se publican API, planes y productos
para las “consumer organizations”. Los proveedores de API pueden organizar sus
Productos en Catálogos o Espacios y luego publicarlos para que las API de esos
Productos estén visibles en un Portal para desarrolladores para el
descubrimiento externo.

Para controlar el acceso a las funciones de administración de API disponibles, los

usuarios de la organización del proveedor se pueden configurar en la interfaz de
usuario de API Manager con roles y permisos asignados.

4.4 API Gateways

Las “API Gateways” imponen políticas de tiempo de ejecución para proteger y

controlar el tráfico de API. Además, proporcionan los endpoints que exponen las
API y proporcionan funciones de ensamblaje que permiten que las API se
integren con varios endpoints.

También, registran e informan todas las interacciones de API al motor de

analítica de API Connect, para análisis e informes históricos y en tiempo real.

El DataPower gateway® es un Gateway de API empresarial diseñada para uso

entre empresas. Este Gateway proporciona un conjunto completo de políticas
API para la seguridad, la gestión del tráfico, la mediación, la aceleración y el
soporte de protocolos que no son HTTP.

4.5 Runtime
 Se puede ejecutar APIs y aplicaciones en un entorno contenerizado. Un entorno
contenerizado permite una implementación ligera. Un entorno de contenedores
envuelve una aplicación con un sistema de archivos completo que incluye todo
lo necesario para su ejecución.

4.6 Developer Portal

El “Developer portal” proporciona un portal de autoservicio personalizable

basado en la web para que los desarrolladores de aplicaciones exploren,
descubran y suscriban las API.

Cuando los proveedores de API publican API en el “API Manager”, esas API se
exponen en el “Developer Portal” para que los desarrolladores de aplicaciones
las descubran y utilicen en las organizaciones consumidoras.

4.7 API Analitics

API Connect proporciona la capacidad de filtrar, ordenar y agregar los datos de

eventos de API. Luego, estos datos se presentan en gráficos, tablas y mapas
correlacionados para administrar los niveles de servicio, establecer cuotas,
establecer controles, configurar políticas de seguridad, administrar comunidades
y analizar tendencias.

El análisis de API se basa en la plataforma de visualización y análisis de código

abierto Kibana V5.5.1, que está diseñada para funcionar con el motor de análisis
y búsqueda distribuida en tiempo real de Elasticsearch.

5. Terminología en API Connect

IBM API Connect utiliza una estrategia propietaria para crear y publicar sus de API:

5.1 API
Una API es un conjunto de rutinas, protocolos y herramientas para crear
aplicaciones de software. Una API especifica cómo interactúan los componentes
de software y proporciona acceso rápido a activos y procesos comunes.

Las API REST utilizan solicitudes HTTP o HTTPS para PUT, GET, POST y DELETE
datos (también denominadas operaciones CRUD). REST identifica recursos
mediante URI. Los datos se pueden describir en una variedad de formatos (XML,
HTML, JSON, TXT, etc.), siendo JSON la opción más popular.

Una API SOAP (Protocolo simple de acceso a objetos) es un servicio web que se
expone como una API. Las interfaces SOAP se describen en formato WSDL. El
WSDL es un documento XML que describe la estructura de encabezados,
mensajes, extremos de URL y tipos de datos que se utilizan para acceder a un
servicio web. SOAP se considera más seguro que REST, ya que admite WS-
Security y SSL.
5.2 Plans & Products

Los proveedores de API utilizan Productos para ofrecer una o más API a los
desarrolladores de aplicaciones que consumirán las API (consumidores de API).

Los Planes se utilizan para controlar el acceso a las API y para administrar el uso
de las API.

Los productos son paquetes que contienen tanto las API como los planes que las
acompañan. Para que una API esté disponible para un desarrollador de
aplicaciones, debe estar incluida en al menos un Producto y al menos un Plan.

Las siguientes reglas se aplican a la relación entre Productos y Planes:

⮚ Un Plan puede pertenecer a un solo Producto.
⮚ Un producto puede tener varios planes, cada uno de los cuales contiene un
conjunto diferente de API.
⮚ Un plan en un producto puede compartir API con planes de cualquier otro
producto.

Varios planes dentro de un solo producto proporcionan diferentes niveles de

rendimiento para la misma oferta. Por ejemplo, un Producto puede incluir un
Plan de demostración que hace que una única API esté disponible y un Plan
completo que hace que varias API estén disponibles.

5.3 Catalogs

Un catálogo contiene una colección de productos. Los catálogos se utilizan para

separar Productos y API para realizar pruebas antes de publicarlos en un Portal
para desarrolladores.

En un flujo de trabajo típico, un proveedor de API usa un catálogo de desarrollo

cuando desarrolla y prueba API, y usa un catálogo de producción para publicar
 API que están listas para uso externo. Cada Catálogo tiene un Portal de
Desarrollador asociado para exponer los Productos publicados.

API Connect incluye una función de distribución que permite a los proveedores
de API dividir un catálogo en varios espacios para fines de desarrollo de API.
Cada equipo de desarrollo de proveedores de API puede utilizar su propio
espacio dedicado para gestionar sus productos de forma independiente de otros
equipos.

5.4 Organizations:

En el contexto de API Connect, hay dos tipos de organizaciones: proveedor y

consumidor. Una organización puede abarcar un equipo de proyecto, un
departamento o una división.

5.4.1 Provider Organizations:

Una organización proveedora realiza muchas tareas durante el ciclo de

vida de una API, desde desarrollar, publicar y mantener API hasta
administrar la membresía de la propia organización. Cada organización
proveedora puede ser tan grande o pequeña como sea necesario. Una
empresa grande puede crear una organización proveedora para cada
equipo de producto o para cada departamento, pero una empresa
pequeña puede utilizar una sola organización proveedora.
 Una persona puede ser miembro de varias organizaciones de
proveedores y recibir un conjunto diferente de permisos para cada una.
Cuando el usuario inicia sesión en API Connect, selecciona la
organización cuyos recursos utilizará y recibe los permisos adecuados
para esa organización durante la duración de la sesión.

Roles:

⮚ Organization Owner: El propietario de la organización tiene acceso

completo a todos los recursos de la organización proveedora (API,
productos, catálogos, etc.) y el rol no se puede eliminar. El
propietario de la organización puede agregar personas al rol de
administrador de la organización.

⮚ Organization Manager: Los gerentes de organización agregan

miembros a las organizaciones de proveedores y les asignan los
permisos necesarios para realizar sus trabajos.

⮚ API Developer: Un desarrollador de API crea nuevas API y actualiza

las API existentes según sea necesario. El desarrollador de API puede
estar asignado para trabajar con un catálogo específico que
administra un subconjunto de API, o puede recibir acceso a todos los
catálogos de la organización proveedora y los espacios dentro de
cada uno. Los desarrolladores de API suelen estar más preocupados
por la documentación relacionada con el desarrollo de API, la gestión
de la configuración de API y las políticas de creación de API.

⮚ API Administrator: Después de que un desarrollador de API crea un

conjunto de API, el administrador de API gestiona la distribución. El
administrador de API define planes que determinan el acceso a las
API, recopila las API relacionadas en productos y las publica en los
portales de desarrolladores de consumidores

⮚ Product Manager: Un administrador de productos controla el acceso

al Portal para desarrolladores donde los clientes se suscriben a las
API y luego realiza un seguimiento del uso y el rendimiento de las API.
Para cada cliente, el gerente de producto crea una organización de
consumidores, asigna un representante del cliente como propietario
y gestiona la relación entre la organización proveedora y cada
organización de consumidores. El gerente de producto utiliza el
servicio API Connect Analytics para realizar un seguimiento del uso y
el rendimiento de la API para que la organización proveedora sepa
cuándo las API deben actualizarse o retirarse.

5.4.2 Consumer Organization:

 Una organización de consumidores crea aplicaciones que utilizan las API
desarrolladas por organizaciones de proveedores. Las API de cada
proveedor están disponibles para cada organización de consumidores en
el Portal para desarrolladores de API Connect.

Roles:

⮚ Consumer Organization Owner: Después de que un desarrollador de

API crea un conjunto de API, el administrador de API gestiona la
distribución. El administrador de API define planes que determinan el
acceso a las API, recopila las API relacionadas en productos y las
publica en los portales de desarrolladores de consumidores

⮚ Application Developer: Crea aplicaciones que invoquen las API

compartidas a través del Portal del desarrollador

5.5 Applications

Además de las API, las organizaciones de proveedores también pueden crear

aplicaciones que servirán para utilizar las APIs. La creación de aplicación se
realiza en el portal de desarrolladores. Cada aplicación contará con un Clien Id
que servirá de identificador para invocar las operaciones de las APIs a las que se
suscriba.

5.6 Suscriptions
 Luego de que el API es expuesta en el Developer Portal una Aplicación puede
suscribirse a un Plan y a un Producto.

5.7 Ejemplo de una organización proveedora