📖 Tabla de Contenidos
¿Qué son los registros de API y webhooks?
Los registros de API y webhooks son una especie de registro de la actividad técnica. Contienen las interacciones entre tu sistema y Yousign, lo que incluye:
Llamadas API enviadas a Yousign
Webhooks enviados de Yousign a tu sistema
Detalles de la solicitud y respuesta
Estado de cada evento (completado o error)
Son fundamentales para los desarrolladores para:
Investigar errores
Comprender comportamientos inesperados
Depurar integraciones de forma más independiente
Cómo acceder a los registros de API y webhooks
Puedes acceder a los registros de dos maneras:
Desde el menú principal
En la barra lateral izquierda, haz clic en Desarrolladores.
Podrás acceder a Claves API y webhooks.
Directamente desde una invitación de firma
Si estás investigando una invitación de firma específica:
Abre la página de detalles de la invitación de firma.
Haz clic en el menú de los tres puntos (⋯).
Verás las siguientes opciones:
Ver registros de llamadas API
Ver registros de webhooks
Ver webhooks
Se te enviará a la página Registros con un filtro automático aplicado a la invitación de firma, lo que te permitirá ahorrar tiempo a la hora de solucionar problemas.
Comprender la conservación de los registros (según el plan)
Los registros se almacenan durante un tiempo limitado, según el plan de suscripción:
Plan | Tiempo de conservación del registro |
Plus | 1 día |
Pro | 7 días |
Scale | 30 días |
Período de prueba de la API | 7 días |
Después de este período, los registros se eliminarán de forma permanente y no se podrá acceder a ellos.
Si con frecuencia investiga problemas varios días después de que se produzcan, el período de conservación de los registros puede afectar a su capacidad para solucionar los problemas.
Buscar y filtrar los registros de manera eficaz
La página Registros puede contener una gran cantidad de eventos. Los filtros te ayudan a encontrar rápidamente el que necesitas.
En la parte superior de la página, puedes elegir ver:
Llamadas API
Webhooks enviados
A continuación, usa Filtros para restringir la búsqueda. Puedes filtrar por:
🔎 ID de la invitación de firma
Busca registros vinculados a un ID de invitación de firma específico. Esta función resulta muy útil cuando se generan muchos registros cada segundo.
⏱ Intervalo de tiempo
Filtra los registros utilizando un intervalo de tiempo preciso, en lugar de solo una fecha.
Así, te resultará mucho más fácil localizar un evento que se produjo en un momento específico.
📌 Código de estado
Filtra por estado para identificar rápidamente las llamadas completadas o fallidas.
🔑 Clave API (solo registros de API)
Si utilizas varias claves API, puedes filtrar los registros por clave API para ver solo las llamadas realizadas con una clave específica.
Haz clic en "Aplicar" para activar los filtros.
¿Qué se guarda en los registros?
Los registros proporcionan información técnica detallada, que incluye:
Todas las llamadas API, incluidas solicitudes GET (como recuperar invitaciones de firma o información del firmante)
Eventos de webhook enviados por Yousign
Órganos de solicitud y respuesta
También se almacenan las solicitudes y respuestas utilizando multipart/form-data (por ejemplo, al cargar documentos), lo que permite ver el intercambio técnico completo.
Ver detalles del registro
Para ver todos los detalles:
Haz clic en una llamada API o webhook de la lista.
Se abrirá un panel lateral con los detalles técnicos.
Puede expandir este panel a página completa para facilitar la lectura al revisar cargas útiles complejas.
¿Necesitas ayuda para investigar un problema?
Si los registros no explican claramente lo que ha sucedido, nuestro equipo puede ayudarte a investigarlo más a fondo.
Puedes contactarnos directamente desde la aplicación:
Haz clic en el botón Ayuda del lado izquierdo de la pantalla (justo encima de Ajustes).
Elige "Comparte tus comentarios" o "Contáctanos".
Para ayudarnos a analizar el problema más rápido, incluye:
El ID de invitación de firma (si corresponde)
La fecha y hora aproximadas del problema
Si la llamada API o el webhook se encuentran en estado de error o completado
Cualquier mensaje de error pertinente presente en los registros
Si proporcionas estos detalles técnicos, nuestro equipo podrá investigar el problema con mayor eficacia.