Conoce más sobre excepciones, códigos de error y su estructura – Centro de Ayuda APIs Internas

El estándar de mensajería y puntualmente el de excepciones es una herramienta tanto para los productores, como para los consumidores de APIs, es por esto que, en este artículo queremos contarte dónde encuentras este estándar y cómo este va ha apalancar a tu equipo.

En Bancolombia trabajamos sobre unos estándares que le permiten a los productores guiarse en el diseño y construcción de sus APIs, aumentando su calidad y reduciendo conjeturas. Si eres consumidor conocer estos estándares te permitirá saber como actuar ante un mensaje no esperado, evitando dependencias del equipo productor.

¿Dónde encontrar el lineamiento?

Lo puedes consultar en el sitio de Gobierno de APIs/ APIs/ Manejo de excepciones, allí encontrarás el documento Estructura de Mensajería para Excepciones.

¿Dónde consulto las excepciones del API que estoy consumiendo?

Las excepciones las encuentras en la documentación del API que estas consumiendo, dentro del contrato vas a encontrar los códigos y la descripción asociada a cada código; en los escenarios funcionales adicionalmente encontraras que condiciones generan esa excepción. Si consultas la estructura de mensajería adicional podrás comprender que códigos de errores están asociados a errores en el consumo y cuales a factores técnicos.

Por lo anterior, te dejamos unas recomendaciones ante estos errores en el consumo más frecuentes:

Código HTTP	Causa de respuesta
400	Este error se da porque no se está enviando la petición correctamente acorde a la firma de la API. Valida el correcto envío de los campos de las APIs, puede que haya un campo requerido, vacío o con un valor que no corresponde.
401	Uno de los motivos principales de este error es que no se tienen autorización. El token que genera el API Authorization tiene tiempo limitado, en caso de usarlo después de dicho tiempo o ingresarlo de forma errada, te genera este error 401.Otro motivo puede darse por error en las credenciales (client id y client secret) Para superar este error te sugerimos, validar que: La APP creada en el portal de APIs esté suscripta al producto de APIs correcto. Las credenciales (client id y client secret) utilizadas para consumir el API de autorización (API utilizada para generar el token) correspondan a las generadas para la APP el scope o ambito sea el respectivo a los productos de APIs que estas consumiendo.
404	Este error se puede dar porque el recurso solicitado no existe. Revisa que los datos enviados en la petición correspondan con un recurso existente, por ejemplo, puede que tu usuario sea cliente del banco, pero no tiene un producto válido para esa API.Otro error frecuente es que el endpoint este errado al realizar la petición, tal vez por un error de digitación o puede ser un problema con la suscripción de la APP en el portal de APIs. También se puede generar por incidentes temporales con relación a los DNS o temas de firewall a nivel del banco, el consumidor o el proveedor de internet, pero suelen ser incidentes más transversales ajenos al API.
429	Revisa los QoS de la API, ya que este error puede estar relacionado con la cantidad de peticiones que puedes enviar.