Apoyo a equipos productores

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.

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.

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?

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.

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.

¡Nos alegra que estés en proceso de vinculación al Modelo de Soporte a Desarrolladores!. Para que desde el Centro de Ayuda APIs internas le podamos ofrecer una experiencia de soporte superior al usuario, es importante que tengas esto en cuenta: 

Actualmente el portal de APIs en ambiente Sandbox no cuenta con la documentación de los productos. Debido a eso los usuarios reciben las credenciales junto con el kit de información Sandbox.

Este kit lo envían los agentes de primer nivel y contiene la documentación que regularmente se incluye en el portal. Debes construir esta información para las APIs externas que estés desarrollando y suministrarla al Centro de Ayuda APIs internas para que ellos la repliquen entre los usuarios.  

¿Qué debe contener el kit?

El kit es una carpeta comprimida que contiene:

1. Presentación o manual en PDF para que el usuario sepa cómo comenzar. El documento debe contener:
   • Conceptos y generalidades
   • Proceso de generación API (importar firma, configurar firma, collection y funcionalidades, ID y Secreto, endpoints)
   • Descripción de campos
2. Colección de datos: relaciona la colección de datos de prueba. Esta información debe estar actualizada, con las extensiones y retornos correctos.

3. Contratos de cada API

¡Lo mas importante siempre será enseñarle el camino más fácil a nuestro consumidor!.

¿Dónde lo debo dejar cuando lo tenga?

Una vez tengas armado el kit ingresa a este link, busca el producto de API/ documentación técnica/ credenciales e información Sandbox API Connect Versión 10.