Vous pourriez avoir besoin de rediriger le participant vers une page web personnalisée après qu’il/elle ait complété son action. C’est à cela que sert la redirection web.
Configurer les URLs de redirection autorisées
Depuis l’espace développeur de votre espace de travail, vous pouvez configurer la redirection web. Pour ce faire, accédez à la section Intégration de l’espace développeur et ajoutez à la liste blanche les domaines de votre choix (exemple https://www.myredirecturl.com).
Notez que seules les URLs sécurisées (https) sont autorisées.
Configurer la redirection dynamique
Dans certains cas, vous ne pouvez pas définir explicitement l’URL exacte vers laquelle vous souhaitez rediriger le participant. Par exemple, si vous utilisez différents environnements, vous pouvez avoir besoin de configurer une URL de redirection dynamique en utilisant un astérisque [*] comme caractère générique. Pour plus d’informations, voir les exemples ci-dessous :
| Exemple d’URL dynamique | Valide | Description |
|---|---|---|
| https://*.test.fr | OUI | Ceci est un exemple d’URL de redirection dynamique valide. |
| https://*.fr | NON | Le domaine (test) est manquant dans l’URL de redirection dynamique. |
| http://*.test.fr | NON | L’URL de redirection dynamique est complète, mais non sécurisée. Seules les URLs en https sont autorisées. |
| https://test.*.test.fr | NON | Le caractère générique * doit être au début de l’URL dynamique (et ne pas être précédé par le domaine). |
| https://*test.fr | NON | Le * et le domaine (test) doivent être séparés par un .. |
Spécifier une URL de redirection pour un participant
Cas d’usage 1 : Vous gérez l’envoi des emails d’invitation
Cela se fait en 3 étapes :
1. Créez une transaction avec au moins un participant.
2. Récupérez l’action.URL dans la réponse API.
"actions" : [ {
"id" : "act_PrDr5KEnVOlZW",
"actor" : "[email protected]",
"state" : "open",
"started_at" : "2022-11-07T17:27:16Z",
"url" : "https://apps.universign.net/npds/act_PrDr5KEnVOlZW",
"tasks" : [ {
"type" : "signature",
"state" : "todo",
"field" : "fld_vbO"
} ],
} ]
3. Ajoutez l’URL de redirection complète à l’URL d’action, précédée du préfixe ?redirect_url, comme suit :
https://apps.universign.net/npds/act_PrDr5KEnVOlZW?redirect_url=https://www.myredirecturl.com/sample_page
Une fois que le participant a effectué son action, il/elle sera redirigé(e) vers l’URL que vous avez précédemment passée.
Notez que vous pouvez définir un délai avant que votre signataire ne soit redirigé vers l’URL. Pour ce faire, ajoutez le délai en secondes à l’URL de l’action, précédé de redirect_time_out, comme suit :
https://apps.universign.net/npds/act_PrDr5KEnVOlZW?redirect_url=https://www.myredirecturl.com/sample_page&redirect_time_out=5
Cas d’usage 2 : Universign gère l’envoi des emails d’invitation
Cela se fait en 2 étapes :
- Créez une transaction via une requête de transaction complète et passez l’URL de redirection complète de votre choix dans l’argument
invitation_redirect_url.
{
"participants" :
{
"email" : "[email protected]",
"schedule" : [0],
"fullname_prerequisite" : "Jane Doe",
"invitation_subject" : "This is an invitation subject",
"invitation_message" : "This is an invitation message",
"invitation_redirect_url" : "https://www.myredirect_url.com/sample_page"
}
}
Notez que vous pouvez définir un délai avant que votre signataire ne soit redirigé vers l’URL. Pour ce faire, ajoutez le délai en secondes à l’URL de redirection, précédé de redirect_time_out, comme suit :
{
"participants" :
{
"email" : "[email protected]",
"schedule" : [0],
"fullname_prerequisite" : "Jane Doe",
"invitation_subject" : "This is an invitation subject",
"invitation_message" : "This is an invitation message",
"invitation_redirect_url" : "https://www.myredirect_url.com/sample_page&redirect_time_out=5"
}
}
2. Notre système capture l’URL de redirection que vous avez passée, la compare à vos domaines autorisés et l’ajoute aux liens des :
- emails d’invitation,
- emails de rappel.
Une fois que le participant a effectué son action, il/elle sera redirigé(e) vers l’URL que vous avez précédemment passée.
Résultats de la transaction
Selon que le participant ait complété son action ou refusé de la compléter, vous pouvez récupérer le statut de l’action du participant à partir de l’URL.
Notez que les résultats des transactions ne s’affichent que si vous définissez une URL de redirection.
Le participant a complété son action
Si le participant a complété avec succès son action, il/elle sera redirigé(e) vers l’URL de votre choix. Vous recevrez un paramètre supplémentaire outcome=success qui est ajouté à l’URL de redirection :
https://www.myredirecturl.com?outcome=success
Le participant a refusé de compléter son action
Si le participant a refusé de compléter son action (en cliquant sur Refuser les documents), il/elle sera redirigé(e) vers l’URL de votre choix. Vous recevrez un paramètre supplémentaire outcome=refusal qui est ajouté à l’URL de redirection :
https://www.myredirecturl.com?outcome=refusal
La transaction est annulée
Si vous annulez une transaction en cours, le participant sera redirigé(e) vers l’URL de votre choix. Vous recevrez un paramètre supplémentaire outcome=cancelled qui est ajouté à l’URL de redirection :
https://www.myredirecturl.com?outcome=cancelled
La transaction est expirée
Si la transaction expire avant que le participant n’effectue son action, il/elle sera redirigé(e) vers l’URL de votre choix. Vous recevrez un paramètre supplémentaire outcome=expired qui est ajouté à l’URL de redirection :
https://www.myredirecturl.com?outcome=expired
