Saltar al contenido principal
Al integrar con nuestra API, el manejo robusto de errores es esencial para una experiencia de usuario fluida y un rendimiento de aplicación resiliente. Al abordar los errores de manera efectiva, su aplicación puede gestionar problemas con gracia, minimizar interrupciones y mantener la capacidad de respuesta. Los pasos clave incluyen:
  • Aprovechar nuestro modelo de respuesta de error estandarizado.
  • Mantener su lógica de manejo de errores actualizada para adaptarse a cualquier cambio en la API.

​
Modelo de respuesta de error

Nuestras APIs devuelven un objeto de error estructurado para todos los errores con el fin de simplificar el diagnóstico de problemas. El formato es el siguiente: 
{
   "code":"<error_code>",
   "title":"<error_title>",
   "message":"<error_message>"
}
Definiciones de campos:
  • code: Un identificador único y estable para el error.
  • title: Un resumen breve del problema.
  • message: Orientación detallada para resolver el error.

​
Detalles de error a nivel de campo

Para problemas específicos de campos individuales, un objeto fields proporciona contexto adicional. Ejemplos: 
{
   "code":"0009",
   "title":"Missing Fields in Request",
   "message":"Your request is missing one or more required fields. Please refer to the documentation to ensure all necessary fields are included in your request.",
   "fields": {
      "{{field}}": "{{field}} is a required field"
   }
}

​
Mejores prácticas para el manejo de errores de API

​
1. Enfóquese en los códigos de error

  • Los códigos de error son estables e ideales para una lógica de manejo confiable.
  • Mapee los códigos de error a resoluciones específicas para garantizar la compatibilidad con las actualizaciones de la API.

​
2. Registre e informe

  • Registre los errores para monitoreo y solución de problemas.
  • Proporcione retroalimentación clara y procesable a los usuarios con sugerencias para la resolución.

​
3. Manténgase actualizado

  • Revise regularmente la documentación de códigos de error para alinearse con condiciones nuevas o actualizadas.
  • Mantenga la lógica de manejo de errores adaptable a futuros cambios.
Adherirse a estas prácticas garantiza una integración robusta y una experiencia de usuario excepcional.