Une Handover URL est un lien de redirection prédéfini dans les paramètres de la transaction, qui vous permet de déterminer où l'Signer Experience sera déplacée après qu'un destinataire aura interagi avec une transaction. L'URL se déclenchera différemment à certains égards. Le scénario le plus courant est celui où un signataire a fini de signer. L'URL de transfert s'affiche sous forme de bouton de sortie dans la barre d'actions globale et dans la barre d'outils.

Les URL de transfert peuvent également être utilisées comme un crochet pour envoyer des messages en temps réel à vos extrémités concernant l'événement déclenché. Une fois que le signataire a cliqué sur le lien URL de transfert, des paramètres supplémentaires seront attachés au lien, notamment « paquet », « signataire » et « statut ».

Par exemple, si vous avez spécifié l'URL de transfert comme : 

https://yourdomain/oss/handover

Après que le destinataire, dont l'ID de signataire est Signer1 a refusé la transaction (ID de « T840KlFsIeC--LqGu9O9Enp9T6I »), les informations associées à cet événement seront transmises par des paramètres, et le lien réel que le destinataire touchera ressemblera à ceci :

https://yourdomain/oss/handover?package=T840KlFsIeC--LqGu9O9Enp9T6I%3D&signer=Signer1&status=PACKAGE_DECLINE

Les URL de transfert peuvent être définies aux niveaux suivants :

  • Paquet

  • Compte

  • Langue

Par paquet

Pour définir une URL de transfert au niveau du paquet, vous devez spécifier trois valeurs dans les paramètres du paquet :

  • Href du lien de transfert : Définit l'URL de redirection vers laquelle le signataire sera envoyé.

  • Texte du lien de transfert : Le texte qui apparaîtra sur le bouton de transfert.

  • Titre du lien de transfert / Infobulle : Le texte qui apparaîtra au survol du bouton de transfert.

Si vous avez besoin d'une comparaison avec la procédure de création d'objets de base, ou si c'est la première fois que vous créez une transaction, consultez la rubrique Création et envoi d'une transaction.

Le code suivant vous montre comment modifier le bloc de paramètres lors de la création d'un paquet. 

.withSettings(DocumentPackageSettingsBuilder.newDocumentPackageSettings()
			            .withHandOverLinkHref("https://www.google.com")
	          .withHandOverLinkText("Exit to site")
	    .withHandOverLinkTooltip("You will redirected to Google homepage")
              )

Par compte

Comme l'URL de transfert est un paramètre du paquet, il est possible de définir l'URL de transfert par défaut au niveau du compte. Si votre flux de travail nécessite que vous redirigiez l'Signer Experience vers une page d'achèvement générale, ou vers le site Web de votre organisation, communiquez avec notre équipe de soutien et fournissez-leur les éléments suivants :

  • Href du lien de transfert : Définit l'URL de redirection vers laquelle le signataire sera envoyé.

  • Texte du lien de transfert : Le texte qui apparaîtra sur le bouton de transfert.

  • Titre du lien de transfert / Infobulle : Le texte qui apparaîtra au survol du bouton de transfert.

Une fois que cela est fait, tout nouveau paquet que vous créez aura ces valeurs par défaut.

Par langue

Différentes URL de transfert peuvent être spécifiées pour différentes langues. Par exemple, si vous avez un site multilingue et que vous souhaitez diriger le signataire vers différentes versions linguistiques en fonction de sa langue. Pour ce faire, vous pouvez communiquer avec notre équipe de soutien et faire configurer différentes URL de transfert sur votre compte.

Vous pouvez également personnaliser les URL de transfert à l'aide des SDK. L'exemple de code suivant montre comment tirer parti de la classe AccountConfigService pour spécifier l'URL de transfert pour chaque localisation de Java.

AccountConfigService accountConfigService = eslClient.getAccountConfigService();
				Handover handoverAfterCreating = accountConfigService.createHandoverUrl(HandoverBuilder
				.newHandover(java.util.Locale.ENGLISH)
				.withHref("https://www.google.com ")
				.withText("Exit to site ")
				.withTitle("You will redirected to Google homepage ")
				.build()
			);

Recherche d'une configuration de langue existante

Si vous voulez savoir s'il y a des configurations existantes définies pour une langue, utilisez le code suivant :

Handover handoverExisting = accountConfigService.getHandoverUrl(java.util.Locale.ENGLISH);

Mise à jour d'une configuration de langue existante

Pour mettre à jour une configuration de langue existante, utilisez la fonction updateHandoverUrl() :

Handover  handoverAfterUpdating = accountConfigService.updateHandoverUrl(HandoverBuilder
				.newHandover(java.util.Locale.ENGLISH)
				.withTitle(“The updated tooltip”)   
				.build()
				);;

Suppression d'une configuration de langue existante

Pour supprimer un paramètre d'URL de transfert, utilisez le code suivant :

accountConfigService.deleteHandoverUrl(java.util.Locale.ENGLISH);

Une Handover URL est un lien de redirection prédéfini dans les paramètres de la transaction, qui vous permet de déterminer où l'Signer Experience sera déplacée après qu'un destinataire aura interagi avec une transaction. L'URL se déclenchera différemment à certains égards. Le scénario le plus courant est celui où un signataire a fini de signer. L'URL de transfert s'affiche sous forme de bouton de sortie dans la barre d'actions globale et dans la barre d'outils.

Les URL de transfert peuvent également être utilisées comme un crochet pour envoyer des messages en temps réel à vos extrémités concernant l'événement déclenché. Une fois que le signataire a cliqué sur le lien URL de transfert, des paramètres supplémentaires seront attachés au lien, notamment « paquet », « signataire » et « statut ».

Par exemple, si vous avez spécifié l'URL de transfert comme : 

https://yourdomain/oss/handover

Après que le destinataire, dont l'ID de signataire est Signer1 a refusé la transaction (ID de « T840KlFsIeC--LqGu9O9Enp9T6I »), les informations associées à cet événement sont transmises par des paramètres, et le lien que le destinataire va cliquer ressemble à ceci :

https://yourdomain/oss/handover?package=T840KlFsIeC--LqGu9O9Enp9T6I%3D&signer=Signer1&status=PACKAGE_DECLINE

Les URL de transfert peuvent être définies aux niveaux suivants :

  • Paquet

  • Compte

  • Langue

Par paquet

Pour définir une URL de transfert au niveau du paquet, vous devez spécifier trois valeurs dans les paramètres du paquet :

  • Href du lien de transfert : Définit l'URL de redirection vers laquelle le signataire sera envoyé.

  • Texte du lien de transfert : Le texte qui apparaîtra sur le bouton de transfert.

  • Titre du lien de transfert / Infobulle : Le texte qui apparaîtra au survol du bouton de transfert.

Si vous avez besoin d'une comparaison avec la procédure de création d'objets de base, ou si c'est la première fois que vous créez une transaction, consultez la rubrique Création et envoi d'une transaction.

Le code suivant vous montre comment modifier le bloc de paramètres lors de la création d'un paquet. 

.withSettings(DocumentPackageSettingsBuilder.newDocumentPackageSettings()
				.withHandOverLinkHref("https://www.google.com")
				.withHandOverLinkText("Exit to site")
			.withHandOverLinkTooltip("You will redirected to Google homepage")
              )

Par compte

Comme l'URL de transfert est un paramètre du paquet, il est possible de définir l'URL de transfert par défaut au niveau du compte. Si votre flux de travail nécessite que vous redirigiez l'Signer Experience vers une page d'achèvement générale, ou vers le site Web de votre organisation, communiquez avec notre équipe de soutien et fournissez-leur les éléments suivants :

  • Href du lien de transfert : Définit l'URL de redirection vers laquelle le signataire sera envoyé.

  • Texte du lien de transfert : Le texte qui apparaîtra sur le bouton de transfert.

  • Titre du lien de transfert / Infobulle : Le texte qui apparaîtra au survol du bouton de transfert.

Par langue

Différentes URL de transfert peuvent être spécifiées pour différentes langues. Par exemple, si vous avez un site multilingue et que vous souhaitez diriger le signataire vers différentes versions linguistiques en fonction de sa langue. Pour ce faire, vous pouvez communiquer avec notre équipe de soutien et faire configurer différentes URL de transfert sur votre compte.

Vous pouvez également personnaliser les URL de transfert à l'aide des SDK. L'exemple de code suivant montre comment tirer parti de la classe AccountConfigService pour spécifier l'URL de transfert pour chaque localisation de Java.

AccountConfigService accountConfigService = eslClient.getAccountConfigService();
				Handover handoverAfterCreating = accountConfigService.createHandoverUrl(HandoverBuilder
				.newHandover(java.util.Locale.ENGLISH)
				.withHref("https://www.google.com ")
				.withText("Exit to site ")
				.withTitle("You will redirected to Google homepage ")
				.build()
			);

Recherche d'une configuration de langue existante

Si vous voulez savoir s'il y a des configurations existantes définies pour une langue, utilisez le code suivant :

Handover handoverExisting = accountConfigService.GetHandoverUrl(“en”);

Mise à jour d'une configuration de langue existante

Pour mettre à jour une configuration de langue existante, utilisez la fonction updateHandoverUrl() :

Handover  handoverAfterUpdating = accountConfigService.updateHandoverUrl(HandoverBuilder
				.newHandover(java.util.Locale.ENGLISH)
				.withTitle(“The updated tooltip”)   
				.build()
			);

Suppression d'une configuration de langue existante

Pour supprimer un paramètre d'URL de transfert, utilisez le code suivant :

accountConfigService.deleteHandoverUrl(java.util.Locale.ENGLISH);

Une Handover URL est un lien de redirection prédéfini dans les paramètres de la transaction, qui vous permet de déterminer où l'Signer Experience sera déplacée après qu'un destinataire aura interagi avec une transaction. L'URL se déclenchera différemment à certains égards. Le scénario le plus courant est celui où un signataire a fini de signer. L'URL de transfert s'affiche sous forme de bouton de sortie dans la barre d'actions globale et dans la barre d'outils.

Les URL de transfert peuvent également être utilisées comme un crochet pour envoyer des messages en temps réel à vos extrémités concernant l'événement déclenché. Une fois que le signataire a cliqué sur le lien URL de transfert, des paramètres supplémentaires seront attachés au lien, notamment « paquet », « signataire » et « statut ».

Par exemple, si vous avez spécifié l'URL de transfert comme : 

https://yourdomain/oss/handover

Après que le destinataire, dont l'ID de signataire est Signer1 a refusé la transaction (ID de « T840KlFsIeC--LqGu9O9Enp9T6I »), les informations associées à cet événement sont transmises par des paramètres, et le lien que le destinataire va cliquer ressemble à ceci :

https://yourdomain/oss/handover?package=T840KlFsIeC--LqGu9O9Enp9T6I%3D&signer=Signer1&status=PACKAGE_DECLINE

Les URL de transfert peuvent être définies aux niveaux suivants :

  • Paquet

  • Compte

  • Langue

Par paquet

Pour définir une URL de transfert au niveau du paquet, vous devez spécifier trois valeurs dans les paramètres du paquet :

  • Href du lien de transfert : Définit l'URL de redirection vers laquelle le signataire sera envoyé.

  • Texte du lien de transfert : Le texte qui apparaîtra sur le bouton de transfert.

  • Titre du lien de transfert / Infobulle : Le texte qui apparaîtra au survol du bouton de transfert.

Si vous avez besoin d'une comparaison avec la procédure de création d'objets de base, ou si c'est la première fois que vous créez une transaction, consultez la rubrique Création et envoi d'une transaction.

Ces attributs sont hébergés dans le paquet JSON à « paramètres » > « cérémonie » > « transfert ». Le code suivant vous donne une idée de la façon dont vous pouvez construire le nœud « paramètres » et inclure les informations de l'URL de transfert lors de la création d'un paquet : 

{
				"status": "DRAFT",
				"settings": {
				"ceremony": {
				  "handOver": {
				        "title": "You will be redirected to Google homepage",
			        	"href": "http://www.google.com",
				        "text": "Exit to site"
				}
				    }
			},
			"type": "PACKAGE",
			"name": "Customized Signer Experience"
	}

Par compte

Comme l'URL de transfert est un paramètre du paquet, il est possible de définir l'URL de transfert par défaut au niveau du compte. Si votre flux de travail nécessite que vous redirigiez l'Signer Experience vers une page d'achèvement générale, ou vers le site Web de votre organisation, communiquez avec notre équipe de soutien et fournissez-leur les éléments suivants :

  • Href du lien de transfert : Définit l'URL de redirection vers laquelle le signataire sera envoyé.

  • Texte du lien de transfert : Le texte qui apparaîtra sur le bouton de transfert.

  • Titre du lien de transfert / Infobulle : Le texte qui apparaîtra au survol du bouton de transfert.

Par langue

Différentes URL de transfert peuvent être spécifiées pour différentes langues. Par exemple, si vous avez un site multilingue et que vous souhaitez diriger le signataire vers différentes versions linguistiques en fonction de sa langue. Pour ce faire, vous pouvez communiquer avec notre équipe de soutien et faire configurer différentes URL de transfert sur votre compte.

Vous pouvez également personnaliser les URL de transfert à l'aide des API REST.

Pour créer un paramètre d'URL de transfert, utilisez l'API suivante.

Requête HTTP

POST /api/accountConfig/handoverUrl/{language_code}

En-têtes HTTP

Accept: application/json 
Content-Type: application/json
Authorization: Basic api_key

Données utiles de la demande

{
            "title": "You will be redirected to Google homepage",
            "href": "http://www.google.com",
            "text": "Exit to site"
             

Recherche d'une configuration de langue existante

Si vous voulez savoir s'il y a des configurations existantes définies pour une langue, utilisez le code suivant :

Requête HTTP

GET /api/accountConfig/handoverUrl/{language_code}

En-têtes HTTP

Accept: application/json 
Authorization: Basic api_key

Données utiles de la réponse

{
              "title": "You will be redirected to Google homepage",
              "href": "http://www.google.com",
            "text": "Exit to site"
} 

Mise à jour d'une configuration de langue existante

Une fois que vous avez créé un paramètre, vous pouvez utiliser l'API ci-dessous pour mettre à jour tout attribut partiel :

Requête HTTP

PUT /api/accountConfig/handoverUrl/{language_code}

En-têtes HTTP

Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Données utiles de la demande

{
              "title": "You will be redirected to Google homepage"
            } 

Suppression d'une configuration de langue existante

Pour supprimer un paramètre d'URL de transfert, utilisez le code suivant :

Requête HTTP

DELETE /api/accountConfig/handoverUrl/{language_code}

En-têtes HTTP

Authorization: Basic api_key