El reto
Seguros Venezuela contaba con diferentes servicios de integración para conectar sus capacidades tecnológicas con aliados comerciales, pero la información necesaria para consumirlos se compartía mediante documentos estáticos y archivos dispersos, principalmente en PDF. Cada servicio requería comunicar métodos, parámetros, estructuras de respuesta y consideraciones de consumo, lo que hacía difícil actualizar y mantener esa información a medida que el ecosistema de integraciones crecía. El desafío no era únicamente publicar APIs, sino ordenar la manera en que su información se administra y se presenta: unificar documentación fragmentada, ofrecer a los aliados un único entorno de consulta, organizar múltiples servicios y proyectos de forma independiente y controlar qué puede hacer cada usuario dentro del sistema.
La solución
Desarrollamos un Sistema de Gestión de Documentación y Exposición de APIs: una plataforma web que centraliza la administración de servicios, organiza su documentación técnica y ofrece un entorno estructurado para que los aliados comprendan y validen las APIs disponibles. La documentación deja de ser un conjunto de materiales aislados y pasa a formar parte de una plataforma donde los servicios se organizan dentro de proyectos API, con métodos de consumo, parámetros de entrada, estructuras de salida y consideraciones de integración presentados de forma consistente. Seguros Venezuela dispone así de un punto central para gestionar los servicios expuestos, los usuarios que participan y los permisos asociados a cada perfil. La plataforma se construyó como una aplicación web administrativa y se validó mediante pruebas funcionales con escenarios positivos y negativos sobre autenticación, usuarios, roles, permisos y gestión de proyectos API, verificadas en Chrome, Edge y Firefox.
El resultado
Centralización de la información y las operaciones relacionadas con proyectos API, usuarios y permisos en un mismo entorno, reduciendo la fragmentación asociada al manejo de documentación independiente.
Qué implementamos
- Gestión centralizada de proyectos API: creación, actualización, activación, desactivación y eliminación.
- Documentación estructurada de cada servicio con método, parámetros requeridos, estructura de respuesta esperada y consideraciones de integración.
- Entorno de validación para realizar pruebas controladas de los servicios y visualizar sus respuestas antes de avanzar con una integración.
- Administración de usuarios: creación, modificación, control de estado, búsqueda y validaciones sobre campos obligatorios, formato de correo y duplicidad.
- Roles y permisos configurables para determinar las funcionalidades disponibles según las responsabilidades de cada perfil.
- Autenticación por correo y contraseña, y recuperación segura de acceso mediante envío y verificación de código antes de actualizar las credenciales.
Impacto y resultados
- Centralización de la información y las operaciones relacionadas con proyectos API, usuarios y permisos en un mismo entorno, reduciendo la fragmentación asociada al manejo de documentación independiente.
- Estructura administrable para documentar y gestionar servicios, que facilita incorporar nuevos proyectos API bajo un mismo modelo.
- Experiencia más clara para los aliados, que pueden consultar y evaluar las características de un servicio antes de avanzar con su integración.
- Relación tecnológica más profesional con los aliados comerciales y base para fortalecer progresivamente el ecosistema de integraciones.
- La documentación de APIs se convierte en un activo propio, administrable y preparado para acompañar el crecimiento de las integraciones, sin depender de la creación y distribución manual de nuevos documentos.
