Preguntas frecuentes

Los features y las colecciones son archivos que utilizan los consumidores para realizar peticiones al sandbox de un api particular y obtener información de esta. Se cargan al bucket y a la plataforma cuando se ejecuta el pipeline de build.

A continuación podrán encontrar información detallada sobre la manera de configurar y desplegar el sandbox para las APIs de API Connect 10: Construcción y despliegue del sandbox.

Si estás experimentando errores en la construcción o configuración del sandbox, te invitamos a leer la siguiente información: Errores comunes en la configuración del sandbox.

Puede servirte de ayuda para solucionarlos.

¡Nos alegra que estés en proceso de vinculación al Modelo de Soporte a Desarrolladores! como tus capacidades comenzarán a ser soportadas por el Centro de Ayuda APIs internas, será necesario que nos brindes información relevante y precisa sobre tus productos para transferir este conocimiento a los agentes de primer nivel. Ellos serán quienes brinden la atención y el soporte en primer contacto con los usuarios.

Es por ello que necesitamos que realices algunos videos (máximo de 20 minutos) donde expongas la siguiente información:

1. Del negocio: cuéntales acerca de tus productos, para qué son, cómo los utiliza tu consumidor y cuál es la lógica de los productos de APIs.
2. El equipo: a veces obviamos cosas, sin embargo, saber quiénes conforman el equipo, en que EVC se encuentran, si hay stand-by o cómo manejar los horarios en los que se reciben los casos, es un complemento perfecto para saber escalar correctamente los casos en segundo nivel.
3. Los requerimientos no funcionales: ayúdales a entender dónde se encuentra la información que debe tener en cuenta en el consumo de APIs.
4. Sandbox: toma las APIs de más demanda y consúmelas en Insomnia, con el fin de hacer práctica la capacitación.
5. Para tus productos de APIs internas, el proceso de reúso: indícales si dentro del proceso realizan actividades adicionales o diferentes al proceso estandarizado.

Aquí te dejamos un video, para que puedas grabar sin inconvenientes el tuyo. Una vez los tengas entra a esta carpeta, busca el nombre de tu equipo y cárgalos.

En el siguiente sitio te explicaremos cómo consumir el sandbox una vez que se ha creado para cada API con todos sus escenarios y su despliegue ha finalizado correctamente: ¿Cómo consumir el sandbox?

Conoce cómo construir y publicar la documentación de negocio de tus productos APIS en el siguiente sitio.

La Hoja de orientación para la construcción de APIs es una herramienta que te ayudará como punto de partida. Detalla cada paso, proceso, tarea y resultado necesario para completar la construcción total de APIs y servicios. Puedes utilizar esta hoja de orientación para guiar tus primeros pasos en el desarrollo de APIs de manera efectiva.

Los atributos de calidad y disponibilidad son fundamentales para definir el comportamiento del sistema en áreas como el rendimiento, la seguridad y la usabilidad, sin entrar en funciones específicas.

Para una mejor comprensión de estos atributos, te invitamos a explorar la siguiente presentación: PPT.

Asimismo, te sugerimos ver el siguiente video para capacitarte en los atributos de calidad y disponibilidad.

Es un plano detallado que permite mapear las capacidades de negocio asociadas a un flujo funcional específico. Este modelo encapsula los servicios y las relaciones que pueden existir entre ellos, ya sea dentro del mismo dominio o entre diferentes dominios.

Ingresa aquí y crea tu propio Blueprint.

Esta herramienta te permite mejorar la forma como priorizas las capacidades que vas a apificar: Matriz de priorización.

Te invitamos a hacer clic en el siguiente link para conocer información sobre el modelo operativo de APIs y servicios : Modelo operativo de APIs y Servicios.

Para una correcta implementación de las colecciones de Postman y los archivos .features te recomendamos: 

1. Verifica que tengas dos carpetas: una llamada "colecciones" y otra llamada "features".
2. Asegúrate de que dentro de estas carpetas existan archivos correspondientes.
3. Es crucial que los nombres de los archivos coincidan exactamente con el nombre del archivo YAML del API en el repositorio, incluyendo mayúsculas y caracteres especiales, ya que se realiza una validación con estos.
4. En relación a los archivos con extensión ".feature", ten en cuenta que solo debe haber un archivo por API. Si tienes varios, es necesario unificarlos.
5. Si se realizan cambios en los nombres de los archivos, vuelve a ejecutar el pipeline de construcción (build).

Encuentra más información en el lineamiento Estructura implementación sandbox.

No, de acuerdo con el modelo de reúso, los consumos los debes realizar en el ambiente de sandbox inicialmente y posteriormente en el ambiente de producción (PDN).

Consulta el proceso completo aquí.

Tu rol como PO se centra en facilitar la solución de las dudas de los usuarios, brindando una respuesta o delegándola a alguien del equipo que la pueda resolver. Es importante que como PO tengas presente la capacidad de tu célula para la atención oportuna de los casos que se escalen a segundo nivel.

Para que tus productos comiencen a ser soportados bajo el MSD, será necesario que nos compartas:

Videos de capacitación: Con este material nuestros agentes de primer nivel obtienen el conocimiento necesario para soportar tus APIs. De ahí la importancia de desarrollar oportunamente este material y de garantizar su calidad.

Contenido como artículos, guías, instructivos o cualquier información importante que complemente la que ya se expone en los portales de APIs.

Además, para disminuir los tropiezos que pueda llegar a tener el consumidor durante el consumo de tus productos, es necesario que dispongas para ellos:

La documentación de los productos en el portal de APIs, en el portal documentación como código y/o en las demás plataformas que establezcan los lineamientos del modelo productor-consumidor. Asegúrate que esta información esté al día y sea actualizada constantemente.

Para ver más detalle de los insumos entregados al nivel 1, puedes verlo aquí.

Para brindar soporte de nivel 2 no necesitas solicitar permisos ya que no usarás ningún aplicativo o plataforma diferente a tu correo electrónico para gestionar el caso que te fue escalado. Para ver más sobre cómo el nivel 2 debe responder los escalamientos, puedes ver aquí.

Cuando un caso de soporte es escalado a nivel 2 no se realiza la creación de una HA en el tablero del equipo. El escalamiento se hace únicamente por correo electrónico. Para ver más sobre cómo el nivel 2 debe responder los escalamientos, puedes ver aquí.

Después de realizar todo el proceso para vincularte al MSD y cuando ya se encuentren todas las configuraciones productivas en el Centro de Ayuda APIs internas, recibirás un correo electrónico en el que te confirmamos que tu producto comienza a ser soportado por nuestros agentes de primer nivel.

El equipo de segundo nivel está conformado por las personas funcionales, técnicas y en algunos casos del back-end, que hacen parte de equipos productores y equipos transversales de APIs. Si necesitas consultar o actualizar los integrantes de tu equipo que están en segundo nivel ingresa aquí.

En algunas ocasiones podría pasar que el consumidor te contacte a ti como primer canal/nivel para solucionar dudas o problemas con respecto a tu producto. Si te encuentras frente a esta situación lo adecuado será redirigir al usuario al Centro de Ayuda APIs internas para que allí gestionen su solicitud bajo el proceso dispuesto para ello.

De esta manera garantizamos que el MSD cumpla su misión y que tu capacidad no se vea reducida por temas de soporte. Recuerda que el segundo nivel solo debe gestionar los casos que el primer nivel le escale.

Cuando al consumir una API se presenta un error que corresponde a la capa de integración, este no se escalará al equipo dueño del producto, sino que esta solicitud se redirigirá al equipo funcional, técnico o back end que corresponda.

El equipo de primer nivel brindará soporte a los consumidores en todos los ambientes y durante todo el proceso de consumo hasta que éste sea exitoso. Esto quiere decir que las preguntas, errores o solicitudes que llegan del usuario pueden estar relacionados con cualquiera de los ambientes donde se realice consumo de los productos de APIs.

Nota: Te sugerimos consumir los productos de APIs desde el ambiente sandbox del portal de APIs internas.

El equipo de nivel 2 utilizará el correo electrónico y no necesitará acceder a nuevas plataformas para gestionar los temas escalados. De esta manera, los equipos productores dedicarán menos tiempo y esfuerzo a soportar sus productos y se podrán enfocar en evolucionarlos y desarrollarlos.

Para ver el detalle de cómo el nivel 2 responde los casos de soporte que se les asigna, puedes verlo aquí.

Para permitir la fluidez en la comunicación entre nuestro equipo (nivel 1) y el tuyo (nivel 2), tendremos un chat en Teams que usaremos para comunicarnos sobre casos de soporte de tus APIs como, por ejemplo, alguna consulta puntual o una aclaración sobre tu producto.

Este chat será utilizado únicamente para buscar, de una manera más ágil y acertada, solucionar las necesidades del consumidor. Pero no debes entender esto como un escalamiento, recuerda que el escalamiento oficial de un caso te llegará a través de correo. Para ver más sobre cómo el nivel 2 debe responder los escalamientos, puedes ir aquí.

Desde que las APIs se despliegan en los diferentes ambientes, deben contar con el soporte. Que tus APIs no tengan sandbox es una deuda técnica que puede afectar las pruebas de consumo que desean realizar los consumidores, especialmente de aquellos que apenas comienzan con una exploración inicial de tus capacidades. Al ser una deuda, tu equipo como dueño de la API debe priorizar desatrazarla y ejecutarla lo más pronto posible.

Si este es tu caso, será importante que tu equipo priorice el cierre de esta brecha y le disponga a los consumidores tan pronto sea posible, los escenarios del sandbox y las colecciones Postman.

• Errores comunes en el consumo de una API, por ejemplo: Validación de credenciales y scope correctos para la generación del token, verificación de headers y body al momento de enviar la petición; o ante caídas de APIC.
• Acompañamiento en la experiencia de producción y consumo de APIs: Apoyamos en estas dos experiencias desde la aclaración y/o énfasis en lineamientos, procesos, modelos y temas transversales en los que los productores y consumidores requieran ayuda.
• Preguntas frecuentes: Sobre cómo probar en sandbox, el proceso de reúso interno y en el externo el proceso de vinculación del consumidor, preguntas del API portal en sus diferentes ambientes o del API Manager.
• Solicitudes: Manejamos las solicitudes generales de los productores y consumidores de APIs.

Los anteriores, por nombrar algunos específicos. Sin embargo, en la medida que atendemos a los consumidores vamos incluyendo en nuestra base de conocimiento los casos que, de acuerdo con nuestro conocimiento y capacidad, podemos seguir atendiendo en primer nivel.

Desde Banca en Movimiento se ha reconocido que los equipos en Bancolombia son los responsables del día a día y de la transformación de tus productos y que, además, son los encargados de garantizar el buen funcionamiento de las soluciones, procesos o productos de principio a fin.

Como equipo productor dueño de tus productos de APIs, eres el responsable del ciclo de vida completo de tus APIs y el soporte hace parte de ese ciclo de vida. El equipo de soporte de nivel 2 será contactado únicamente cuando la necesidad del usuario no haya sido solucionada en el nivel 1.

En el sitio de gobierno puedes encontrar la documentación por cada equipo productor, allí encontrarás información bastante detallada, igualmente puedes consultar La Wiki donde también podrás encontrar información general de interés, o incluso el Portal de documentación cómo código.

Es necesario seguir el estándar de nombramiento, esto evitará la generación de un error al momento de consumir la API.

Te invitamos a revisar el sitio de MAC.

Los portales de APIs, así como el Centro de Ayuda APIs internas está integrado con el directorio activo, por esta razón, los usuarios no requieren un registro o creación de una cuenta y cualquier persona con credenciales banco (correo + contraseña de red), puede acceder a cada uno de ellos. Inclusive nuestro método de autenticación es con Microsoft y con “Single SignOn”, esto quiere decir que si ya estás autenticado en otra de las herramientas de office, cuando ingreses al portal de APIs internas o Centro de Ayuda APIs internas, se tomará la autenticación que ya tienes activa y no tendrás que iniciar sesión nuevamente.