📖 Sommaire
Que sont les logs API & Webhooks ?
Comment accéder aux logs API & Webhooks
Comprendre la conservation des logs (selon le plan)
Rechercher et filtrer les logs efficacement
Que contiennent les logs ?
Voir le détail d’un log
Besoin d’aide pour investiguer un problème ?
Que sont les logs API & Webhooks ?
Les logs API et Webhooks fonctionnent comme un journal d’activité technique. Ils enregistrent les échanges entre votre système et Yousign, notamment :
Les appels API envoyés à Yousign
Les Webhooks envoyés par Yousign vers votre système
Les détails des requêtes et des réponses
Le statut de chaque événement (succès ou erreur)
Ils sont essentiels pour les développeurs pour :
Investiguer des erreurs
Comprendre des comportements inattendus
Déboguer les intégrations de manière plus autonome
Comment accéder aux logs API & Webhooks
Vous pouvez accéder aux logs de deux façons :
Depuis la navigation principale
Dans la barre latérale gauche, cliquez sur Développeurs.
Vous pourrez accéder aux Clés API et aux Webhooks.
Directement depuis une Invitation à signer
Si vous investiguez une Invitation à signer spécifique :
Ouvrez la page de détails de l’Invitation à signer.
Cliquez sur le menu à trois points (⋯).
Vous verrez les options suivantes :
Voir les logs des appels API
Voir les logs des Webhooks
Voir les Webhooks
Vous serez redirigé vers la page des logs avec un filtre automatique appliqué à cette Invitation à signer, ce qui permet de gagner du temps lors du dépannage.
Comprendre la conservation des logs (selon le plan)
Les logs sont conservés pendant une durée limitée selon votre plan d’abonnement :
Plan | Durée de conservation des logs |
Plus | 1 jour |
Pro | 7 jours |
Scale | 30 jours |
API Trial | 7 jours |
Après cette période, les logs sont supprimés définitivement et ne peuvent plus être consultés.
Si vous investiguez régulièrement des problèmes plusieurs jours après leur survenue, votre durée de conservation des logs peut impacter votre capacité à effectuer un dépannage.
Rechercher et filtrer les logs efficacement
La page des logs peut contenir un grand nombre d’événements. Les filtres vous aident à trouver rapidement celui dont vous avez besoin.
En haut de la page, vous pouvez choisir d’afficher :
Les appels API
Les Webhooks envoyés
Ensuite, utilisez Filtres pour affiner votre recherche. Vous pouvez filtrer par :
🔎 ID de l’Invitation à signer
Recherchez les logs liés à un ID d’Invitation à signer spécifique, particulièrement utile lorsque de nombreux logs sont générés chaque seconde.
⏱ Période
Filtrez les logs en utilisant une période précise, et pas seulement une date.
Cela facilite la localisation d’un événement survenu à un moment précis.
📌 Code de statut
Filtrez par statut pour identifier rapidement les appels en erreur ou réussis
🔑 Clé API (logs API uniquement)
Si vous utilisez plusieurs clés API, vous pouvez filtrer les logs par clé API afin de voir uniquement les appels effectués avec une clé spécifique.
Cliquez sur "Appliquer" pour activer vos filtres.
Que contiennent les logs ?
Les logs fournissent des informations techniques détaillées, notamment :
Tous les appels API, y compris les requêtes GET (comme la récupération d’Invitations à signer ou d’informations sur un signataire)
Les événements Webhook envoyés par Yousign
Les corps des requêtes et des réponses
Les requêtes et réponses utilisant multipart/form-data (par exemple lors de l’envoi de documents) sont également enregistrées, ce qui permet de voir l’échange technique complet
Voir le détail d’un log
Pour voir tous les détails :
Cliquez sur un appel API ou un Webhook dans la liste.
Un panneau latéral s’ouvre avec les détails techniques.
Vous pouvez agrandir ce panneau en plein écran pour faciliter la lecture lors de l’analyse de payloads complexes.
Besoin d’aide pour investiguer un problème ?
Si les logs n’expliquent pas clairement ce qui s’est passé, notre équipe peut vous aider à investiguer plus en détail.
Vous pouvez nous contacter directement depuis l’application :
Cliquez sur le bouton Aide sur le côté gauche de l’écran (juste au-dessus des Paramètres).
Choisissez Donnez votre avis & Contactez-nous.
Pour nous aider à analyser le problème plus rapidement, incluez :
L’ID de l’Invitation à signer (si pertinent)
La date et l’heure approximatives du problème
Si l’appel API ou le Webhook affiche un statut d’erreur ou de succès
Tout message d’erreur pertinent visible dans les logs
Fournir ces informations techniques permet à notre équipe d’investiguer plus efficacement.