A medida que las opciones para consumir contenido continúan aumentando, es difícil predecir dónde verán televisión los espectadores o cómo monetizar mejor esa audiencia. Mantener el ritmo requiere soluciones flexibles y preparadas para el futuro que pueda personalizar para hoy con la expectativa de que las necesidades comerciales del mañana cambien.
En Imagine, creemos que la clave para un futuro próspero es habilitar modelos de integración abiertos y fáciles de usar, para que todos podamos avanzar más rápido. Esa creencia fue la fuerza impulsora detrás de una importante iniciativa en toda la empresa que iniciamos en abril de 2022 para crear un portal para desarrolladores de API.
El proyecto API Developer Portal de Imagine se propuso lograr dos objetivos iniciales:
- Amplíe nuestra filosofía de plataforma abierta brindando a los clientes acceso a nuestras API para permitir una integración más sencilla con nuestros productos.
- Cree una herramienta que permita a los socios y clientes potenciales ver cómo los productos Imagine ayudan a impulsar la innovación en un entorno empresarial en constante cambio.
En este blog, le brindamos una visión privilegiada de lo que se necesitó para construir el portal, el estado actual del proyecto y cómo puede obtener acceso a un repositorio de API completamente documentadas y actualizadas continuamente que permiten una rápida integración entre sus herramientas existentes y Las soluciones de Imagine.
Recopilación de nuestros datos
El equipo del proyecto, compuesto por partes interesadas de I+D, gestión de productos, arquitectura y documentación de productos, comenzó discutiendo el alcance inicial del proyecto, revisando otros portales API y documentación, evaluando opciones de herramientas y recopilando nuestras API.
Probablemente no sea una sorpresa que con docenas de productos de hardware y software en la cartera de Imagine y equipos de I+D y productos dispersos globalmente, descubrimos rápidamente que nuestra documentación de protocolo y API existente se creó y mantuvo de diversas maneras a lo largo de los años:
- Diseñado utilizando varios métodos (REST, SOAP, XML, Java, etc.)
- Clasificados por audiencia en API internas, API externas y algunas con puntos finales internos y externos
- Publicadas como guías en PDF que rápidamente quedaron obsoletas.
- Almacenado discretamente en discos duros individuales de I+D donde se podría regular su difusión.
- Escrito con distintos niveles de integridad, documentación y ejemplos de código.
para una integración eficiente
Unificando nuestro enfoque para el desarrollo de API
Al observar la condición históricamente diversa de nuestras API, se creó el siguiente conjunto de objetivos para el Portal de desarrolladores de API:
Cree un estándar para toda la empresa para desarrollar y documentar nuevas API
Nuestras API conectan los productos Imagine entre sí y con los productos de nuestros socios y clientes, por lo que su coherencia es fundamental para una fácil implementación. Inicialmente, analizamos la posibilidad de reescribir todas nuestras API como REST, pero eso no era práctico desde una perspectiva técnica o de recursos; hablaremos más de eso en un momento. En el futuro, todas las API nuevas son REST, basadas en OpenAPI estándar de Swagger.
Almacene todas las API para productos actuales, heredados y futuros
La decisión del equipo de centrarse en el diseño REST significó que algunas de nuestras API y protocolos más antiguos no “encajarían” en la herramienta basada en REST que elegimos para nuestro Portal. Para resolver este problema y centrar nuestros recursos en API más nuevas, nuestro arquitecto creó un proceso para agregar un enlace a nuestras guías de API en formato PDF más antiguas al Portal; las llamamos "API proxy" porque no contienen código. Cuando una guía actualizada esté lista, podemos reemplazar la anterior rápidamente y nuestros clientes podrán acceder a ella inmediatamente en el Portal.
Automatizar (tanto como sea posible) el flujo de trabajo del portal
El objetivo aquí era reducir el compromiso de tiempo de I+D para colocar API nuevas y actualizadas en el Portal. Nuestras API ahora están documentadas en su código, pero esto aumenta la carga para los desarrolladores que saben qué hacen los puntos de integración. Para organizar el desarrollo de API en partes manejables, incorporamos ese trabajo en nuestra planificación SAFe Agile PI y realizamos un seguimiento con tickets de Jira.
Descubra los productos de Imagine: de la A a la X
Después de un año y medio de trabajo, ahora tenemos 36 API y proxies completos en nuestro Portal de desarrollador de API y quedan menos de ocho por agregar, ¡a menos que encontremos otros escondidos en alguna parte! Estas API suman más de 1,600 puntos de integración en nuestros productos más nuevos y heredados: productos de la “A a la X” (pero aún no “Z”). Si no ve uno de sus productos en la lista aquí, es probable que su API esté en progreso.
Internamente, el flujo de trabajo del Portal se está arraigando en los procesos de nuestros equipos y las API actualizadas ahora aparecen junto con los lanzamientos de productos. Nuestro equipo de proyecto se reúne semanalmente para analizar el trabajo actual, resolver problemas y discutir los próximos pasos para mejorar el contenido del Portal. Los equipos de ventas y servicios pueden hacer una demostración de nuestro portal para desarrolladores de API a clientes potenciales y saber que contiene la información más reciente.
Para nuestros socios y clientes que trabajan con Imagine, la capacidad de revisar las API junto con otra información del producto mejora el proceso de descubrimiento. Los clientes que ya implementaron nuestras API nos brindan comentarios (tanto buenos como malos) que ayudan a determinar mejoras en las API y planificar características futuras del producto. Este diálogo nos permite responder más rápidamente a sus necesidades comerciales.
1,739 ¡Puntos de integración y contando!
El portal para desarrolladores de API de Imagine presenta API y servidores proxy para productos nuevos y heredados, que incluyen:
Aviator
Radio
Dominar
Serie D
Plan de juego
Landmark
Ventas
Nexio
OSI
Control de Magallanes
System
Procesador de red Selenio (SNP)
Seguro
Versio
xG lineal
¿Qué puede hacer el portal para desarrolladores de API de Imagine por usted?
Si es nuevo en las líneas de productos de Imagine, pregunte si hay una API compatible con el producto. Consejo: ¡Algunos productos tienen varias API! Podemos mostrarle lo que está disponible en el Portal para desarrolladores de API para que pueda aprender cómo aprovechar las características de un producto, mejorar su velocidad de integración y sus resultados.
Si ya posee productos Imagine, el Portal para desarrolladores de API le permite acceder fácilmente a las versiones más actualizadas de nuestras API y su documentación, para que pueda aprovechar los últimos cambios en nuestra plataforma abierta. A medida que la industria presenta nuevos desafíos comerciales, usted puede adaptar su respuesta rápidamente utilizando menos recursos y maximizando los ingresos.
Lo más importante es que el Portal para desarrolladores de API es otra forma en la que Imagine está trabajando para ayudar a la industria a superar los desafíos comerciales actuales y mantenerse al día con el cambio transformacional.
con el portal API de Imagine
¿Listo para explorar el portal para desarrolladores API de Imagine?
¿Listo para explorar el portal para desarrolladores API de Imagine?
¿Listo para explorar el portal para desarrolladores API de Imagine?
Eche un vistazo a la página API de nuestro Portal del Cliente para obtener una lista completa de las API de productos disponibles actualmente. Puede solicitar acceso a través del Portal del Cliente o comunicarse con su representante de Ventas/Atención.
