Al abrir un ticket de soporte para un problema de la API, proporcionar los detalles técnicos adecuados ayuda al soporte de DQE a reproducir el comportamiento, identificar el servicio implicado e investigar más rápido.
Contexto necesario
- el nombre de su organización;
- el servicio o la API de DQE en cuestión;
- el entorno utilizado, como producción, staging, pruebas o sandbox;
- el endpoint y el método HTTP;
- la fecha y hora de la solicitud, incluyendo la zona horaria;
- el impacto en el negocio del problema.
Detalles de la solicitud y la respuesta
Incluya un ejemplo completo siempre que sea posible. Elimine u oculte la información sensible, como credenciales, tokens, licencias y datos personales, antes de compartirla en un ticket.
- parámetros o cuerpo de la solicitud;
- cabeceras utilizadas, con los valores sensibles ocultos;
- cuerpo de la respuesta;
- código de estado HTTP, si está disponible;
- mensaje de error devuelto por la API;
- ID de correlación o ID de solicitud, si está disponible.
Comportamiento esperado
Explique qué resultado esperaba y por qué. Si el problema se refiere a resultados de dirección, correo electrónico, teléfono o geocodificación, incluya el resultado de validación o respuesta esperado.
Cambios recientes
Mencione cualquier cambio reciente que pueda haber afectado a la integración, como un despliegue, una actualización de red, un cambio de credenciales, un cambio de endpoint, un nuevo entorno o una actualización de configuración.
Artículos relacionados
- How to troubleshoot API authentication issues
- Why is my API request rejected?
- Why does the API return no result?