📖 Indice
Coso sono i registri API e Webhook?
I registri API e Webhook sono come dei registri delle attività tecniche. Registrano gli scambi tra il tuo sistema e Yousign, tra cui:
Chiamate API inviate a Yousign
Webhook inviati da Yousign al tuo sistema
Dettagli di richiesta e risposta
Stato di ogni evento (riuscito o errore)
Sono fondamentali per gli sviluppatori per:
Analizzare gli errori
Comprendere un comportamento inaspettato
Eseguire il debug delle integrazioni più in autonomia
Come accedere ai registri API e Webhook
Ci sono due modi per accedere ai registri:
Dal menu principale
Nella barra a sinistra, fai clic su Sviluppatori.
Qui potrai accedere alle Chiavi API e ai Webhook.
Direttamente da una richiesta di firma
Se stai analizzando una richiesta di firma in particolare:
Apri la pagina dei dettagli della richiesta di firma.
Fai clic sui tre puntini (⋯).
Vedrai le seguenti opzioni:
Visualizza i registri delle chiamate API
Visualizza i registri dei Webhook
Visualizza i Webhook
Ti reindirizzeremo alla pagina Registri con un filtro automatico applicato alla richiesta di firma, utile per accorciare i tempi nella risoluzione dei problemi.
Comprendere la conservazione dei registri (in base al piano)
I registri vengono archiviati per un periodo di tempo limitato, a seconda del tuo piano di abbonamento:
Piano | Durata di conservazione del registro |
Plus | 1 giorno |
Pro | 7 giorni |
Scale | 30 giorni |
Periodo di prova API | 7 giorni |
Dopo questo periodo, i registri vengono eliminati definitivamente e non è più possibile accedervi.
Se spesso analizzi gli errori diversi giorni dopo che si sono verificati, il periodo di conservazione dei registri potrebbe influire sulla tua capacità di risoluzione dei problemi.
Cercare e filtrare i registri in modo efficiente
La pagina Registri può contenere un gran numero di eventi. Grazie ai filtri puoi trovare rapidamente quello che ti serve.
Nella parte superiore della pagina, puoi scegliere se visualizzare:
Le chiamate API
I Webhook inviati
Quindi usa i Filtri per restringere la ricerca. Puoi filtrare per:
🔎 ID richiesta firma
Cerca i registri collegati a uno specifico ID richiesta firma, particolarmente utile quando vengono generati diversi registri al secondo.
⏱ Intervallo di tempo
Filtra i registri secondo un preciso intervallo di tempo, non solo una data.
In questo modo puoi individuare più facilmente un evento verificatosi in un preciso momento.
📌 Codice stato
Filtra per stato per identificare rapidamente le chiamate riuscite o fallite.
🔑 Chiave API (solo registri API)
Se utilizzi più chiavi API, puoi filtrare i registri per chiave API per visualizzare solo le chiamate effettuate con una chiave specifica.
Fai clic su “Applica" per attivare i filtri.
Cosa viene salvato nei registri?
I registri forniscono informazioni tecniche dettagliate, tra cui:
Tutte le chiamate API, comprese le richieste GET (ad esempio, il recupero di richieste di firma o di informazioni sul firmatario)
Eventi Webhook inviati da Yousign
Corpi della richiesta e della risposta
Vengono inoltre memorizzate le richieste e le risposte che utilizzano multipart/form-data (ad esempio, quando si caricano documenti), consentendoti di visualizzare lo scambio tecnico completo.
Visualizzare i dettagli del registro
Per vedere tutti i dettagli:
Fai clic sulla chiamata API o sul Webhook nell'elenco.
Si apre un pannello laterale con i dettagli tecnici.
È possibile espandere il pannello a pagina intera per facilitare la lettura quando si esaminano payload complessi.
Hai bisogno di aiuto per analizzare un problema?
Se i registri non spiegano chiaramente cosa è successo, il nostro team può aiutarti a indagare ulteriormente.
Puoi contattarci direttamente dall'app:
Fai clic sul tasto Aiuto sul lato sinistro dello schermo (appena sopra Impostazioni).
Fai clic su Condividi il feedback o Contattaci.
Per aiutarci ad analizzare il problema più velocemente, includi:
L'ID richiesta firma (se pertinente)
La data e l'ora approssimative in cui si è verificato il problema
Se la chiamata API o il Webhook è in stato di errore o riuscito
Qualsiasi messaggio di errore rilevante presente nei registri
Grazie a questi dettagli tecnici il nostro team potrà indagare con maggiore efficienza.