Seguir las buenas prácticas de integración ayuda a mejorar la fiabilidad, reducir errores evitables y agilizar las investigaciones de soporte al utilizar las API de DQE.
Utilice el entorno correcto
Asegúrese de que cada integración utiliza el endpoint, las credenciales, la licencia y el entorno correctos. Evite mezclar credenciales de producción con entornos de prueba o staging.
Valide las entradas antes de enviar las solicitudes
Limpie y formatee los datos de entrada antes de llamar a las API de DQE. Elimine espacios innecesarios, caracteres ocultos, valores incompletos y comentarios internos que no formen parte de los datos a validar.
Gestione las respuestas de la API de forma explícita
Diseñe su integración para gestionar por separado las respuestas correctas, las solicitudes rechazadas, los casos sin resultado, los tiempos de espera agotados y los errores inesperados. Evite tratar todas las respuestas que no sean de éxito como el mismo problema.
Implemente un comportamiento de reintento seguro
Utilice reintentos controlados para los fallos temporales. Evite bucles de reintento agresivos, especialmente en flujos de trabajo de producción, ya que pueden aumentar el tráfico y dificultar la investigación de incidentes.
Registre contexto técnico útil
Mantenga registros que incluyan marcas de tiempo de las solicitudes, nombres de endpoints, estado de la respuesta, mensajes de error e identificadores de correlación cuando estén disponibles. No registre credenciales, tokens ni datos personales sensibles en texto claro.
Supervise el comportamiento en producción
Realice un seguimiento de las tasas de error, los tiempos de respuesta, la frecuencia de tiempos de espera agotados y los cambios inusuales en las tasas de ausencia de resultados. La supervisión ayuda a identificar problemas de integración o de calidad de los datos antes de que afecten a un gran número de usuarios.
Cuándo contactar con el soporte de DQE
Si necesita ayuda para investigar un comportamiento de la API, proporcione el servicio llamado, el entorno, el endpoint, la marca de tiempo de la solicitud, los detalles de la respuesta, los cambios recientes y ejemplos de solicitudes con los datos sensibles eliminados.