Création d’URL de transfert

Une URL de transfert est un lien de redirection prédéfini dans les paramètres de la transaction, qui vous permet de déterminer où l’expérience du signataire sera déplacée une fois qu’un destinataire a interagi avec une transaction. L’URL sera déclenchée différemment à certains égards. Le scénario le plus courant est lorsqu’un signataire a terminé la signature. L’URL de transfert s’affiche sous la forme d’un 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 webhook pour envoyer des messages en temps réel à vos points de terminaison concernant l’événement déclenché. Une fois que le signataire a cliqué sur le lien URL de remise, des paramètres supplémentaires seront attachés au lien, notamment « package », « signataire » et « status ».

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

https://yourdomain/oss/handover

Une fois que le destinataire avec l’ID de signataire 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 sur lequel le destinataire cliquera 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 :

• Colis

• Compte

• Langue

Par forfait

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

• Lien de transfert Href : Définit l’URL de redirection à 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 lorsque vous survolerez le bouton de transfert.

Si vous avez besoin d’une comparaison avec la procédure de création d’objet de base, ou si c’est la première fois qu’une transaction est créée, reportez-vous à la section Creating and Sending a Transaction.

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

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

Par compte

Étant donné que l’URL de transfert est un paramètre de package, il est possible de définir l’URL de transfert par défaut au niveau du compte. Si votre flux de travail vous oblige à rediriger l’expérience du signataire vers une page d’achèvement général ou vers le site Web de votre organisation, contactez notre équipe d’assistance et fournissez-lui les éléments suivants :

• Lien de transfert Href : Définit l’URL de redirection à 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 lorsque vous survolerez le bouton de transfert.

Une fois cette opération effectuée, tout nouveau package 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 faire naviguer le signataire vers différentes versions linguistiques en fonction de la langue de l’signataire. Pour ce faire, vous pouvez contacter notre équipe d’assistance et 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 paramètre régional 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 souhaitez savoir s’il existe 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 le . 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 URL de transfert est un lien de redirection prédéfini dans les paramètres de la transaction, qui vous permet de déterminer où l’expérience du signataire sera déplacée une fois qu’un destinataire a interagi avec une transaction. L’URL sera déclenchée différemment à certains égards. Le scénario le plus courant est lorsqu’un signataire a terminé la signature. L’URL de transfert s’affiche sous la forme d’un 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 webhook pour envoyer des messages en temps réel à vos points de terminaison concernant l’événement déclenché. Une fois que le signataire a cliqué sur le lien URL de remise, des paramètres supplémentaires seront attachés au lien, notamment « package », « signataire » et « status ».

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

https://yourdomain/oss/handover

Une fois 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 sur lequel le destinataire cliquera ressemble à :

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

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

• Colis

• Compte

• Langue

Par forfait

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

• Lien de transfert Href : Définit l’URL de redirection à 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 lorsque vous survolerez le bouton de transfert.

Si vous avez besoin d’une comparaison avec la procédure de création d’objet de base, ou si c’est la première fois qu’une transaction est créée, reportez-vous à la section Creating and Sending a Transaction.

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

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

Par compte

Étant donné que l’URL de transfert est un paramètre de package, il est possible de définir l’URL de transfert par défaut au niveau du compte. Si votre flux de travail vous oblige à rediriger l’expérience du signataire vers une page d’achèvement général ou vers le site Web de votre organisation, contactez notre équipe d’assistance et fournissez-lui les éléments suivants :

• Lien de transfert Href : Définit l’URL de redirection à 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 lorsque vous survolerez le 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 faire naviguer le signataire vers différentes versions linguistiques en fonction de la langue de l’signataire. Pour ce faire, vous pouvez contacter notre équipe d’assistance et 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 paramètre régional 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 souhaitez savoir s’il existe 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 le . 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 URL de transfert est un lien de redirection prédéfini dans les paramètres de la transaction, qui vous permet de déterminer où l’expérience du signataire sera déplacée une fois qu’un destinataire a interagi avec une transaction. L’URL sera déclenchée différemment à certains égards. Le scénario le plus courant est lorsqu’un signataire a terminé la signature. L’URL de transfert s’affiche sous la forme d’un 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 webhook pour envoyer des messages en temps réel à vos points de terminaison concernant l’événement déclenché. Une fois que le signataire a cliqué sur le lien URL de remise, des paramètres supplémentaires seront attachés au lien, notamment « package », « signataire » et « status ».

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

https://yourdomain/oss/handover

Une fois 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 sur lequel le destinataire cliquera ressemble à :

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

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

• Colis

• Compte

• Langue

Par forfait

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

• Lien de transfert Href : Définit l’URL de redirection à 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 lorsque vous survolerez le bouton de transfert.

Si vous avez besoin d’une comparaison avec la procédure de création d’objet de base, ou si c’est la première fois qu’une transaction est créée, reportez-vous à la section Creating and Sending a Transaction.

Ces attributs sont hébergés dans le package JSON dans « settings » > « ceremony » > « handOver ». Le code suivant vous donne une idée de la façon dont vous pouvez construire le nœud « settings » et inclure les informations de l’URL de transfert lors de la création d’un package :

{
				"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

Étant donné que l’URL de transfert est un paramètre de package, il est possible de définir l’URL de transfert par défaut au niveau du compte. Si votre flux de travail vous oblige à rediriger l’expérience du signataire vers une page d’achèvement général ou vers le site Web de votre organisation, contactez notre équipe d’assistance et fournissez-lui les éléments suivants :

• Lien de transfert Href : Définit l’URL de redirection à 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 lorsque vous survolerez le 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 faire naviguer le signataire vers différentes versions linguistiques en fonction de la langue de l’signataire. Pour ce faire, vous pouvez contacter notre équipe d’assistance et 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

Charge utile 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 souhaitez savoir s’il existe 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

Charge utile de 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 les attributs partiels :

Requête HTTP

PUT /api/accountConfig/handoverUrl/{language_code}

En-têtes HTTP

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

Charge utile 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