Signer Experience Paramètres
  • 27 Feb 2025
  • 14 Minutes à lire
  • Sombre
    Lumière
  • PDF

Signer Experience Paramètres

  • Sombre
    Lumière
  • PDF

Résumé de l’article

SDK Java.NET SDKAPI RESTAPEX SDK

SDK Java

Pour télécharger l'exemple complet de code, consultez notre site Partage de code.

L'OneSpan Sign Signer Experience peut être personnalisée. En personnalisant l'Signer Experience, vous pouvez intégrer de manière transparente le processus de signature dans votre propre site.

Paramètres du paquet de documents

Le tableau suivant fournit une brève description des paramètres Signer Experience qui peuvent être personnalisés. Notez qu'il n'est pas nécessaire de spécifier l'un de ces paramètres. Si un paramètre n'est pas défini, les valeurs par défaut indiquées ci-dessous seront utilisées.

Nom du paramètre

Méthode de paramétrage des paquets de documents

Description

En personne

withInPerson

Définit si tous les documents d'un paquet doivent être signés sur le même appareil.

withoutInPerson (par défaut)

Propriétaire en personne (liste déroulante)

hideOwnerInPersonDropdown

Lorsque la fonction « en personne » est activée, elle définit si le propriétaire du paquet est présent dans le menu déroulant des signataires.

showOwnerInPersonDropdown (par défaut)

Premier affidavit

disableFirstAffidavit

Lorsque l'option en personne est activée, définit si la première page de l'affidavit est affichée lors du changement de signataire à partir du menu déroulant des signataires.

enableFirstAffidavit (par défaut)

Deuxième affidavit

disableSecondAffidavit

Lorsque l'option en personne est activée, définit si la deuxième page d'affidavit s'affiche lors du changement de signataire à partir du menu déroulant.

enableSecondAffidavit (par défaut)

Décliner

withDecline

Définit si un signataire peut refuser le paquet de documents.

withoutDecline (par défaut)

Raison du déclin

withDeclineReason

Définit une raison de refus prédéfinie pour laquelle un signataire refuse de signer un paquet.

Déclin Autre

withDeclineOther (par défaut)

Permet à un signataire d’entrer une raison différente pour refuser de signer un paquet.

withoutDeclineOther

Empêche un signataire d’entrer une raison différente pour refuser de signer un paquet.

Liste déroulante des langues

withLanguageDropdown (par défaut)

Définit si le menu déroulant des langues de la page Signer Experience est affiché.

withoutLanguageDropdown

Afficher la page d’aide

withShowNseHelp

Définit si une page d’aide sera affichée, où vous pouvez fournir des instructions descriptives, des liens externes du site ou des coordonnées que le signataire peut utiliser pour obtenir des informations ou des instructions supplémentaires.

withoutShowNseHelp (par défaut)

Lien de transfert

withHandOverLinkHref

Remplace le bouton Continuer dans l'Signer Experience. S'il est remplacé, le signataire sera redirigé vers une URL que vous spécifiez.

Lien de transfert Info-bulle

withHandOverLinkHrefTooltip

Définit le texte qui apparaîtra lors du survol du bouton de transfert.

Paramètres de lien de transfert

withHandOverLinkParameters(Sets.newHashSet("PACKAGE", "SIGNER", "STATUS"))

Définit les paramètres qui seront ajoutés à l’URL de transfert. Les options disponibles sont ["PACKAGE", "SIGNER", "STATUS"]. Si laissé vide, aucun paramètre ne sera ajouté.

Redirection automatique du lien de transfert

withHandOverLinkAutoRedirect

Redirige automatiquement le signataire vers la page d’URL de transfert une fois que le signataire a terminé la signature.

withoutHandOverLinkAutoRedirect (par défaut)

Filigrane

withWatermark (par défaut)

Définit si les documents signés sont marqués du logo OneSpan Sign.

withoutWatermark

Texte de capture

withCaptureText (par défaut)

Définit si les documents signés sont estampillés avec la date, l'heure et le nom du signataire à chaque endroit où ils ont été signés.

withoutCaptureText

Navigateur

withNavigator (par défaut)

Affiche le Navigateur. Le Navigateur dirige le signataire vers la prochaine signature disponible.

withoutNavigator

Titre

withTitle (par défaut)

Affiche le titre.

withoutTitle

Barre de progression

withProgressBar (par défaut)

Affiche la barre de progression.

withoutProgressBar

Bouton Télécharger

withDocumentToolbarDownloadButton (par défaut)

Définit si le bouton de téléchargement est disponible.

Afficher le logo dans iFrame

withShowNseLogoInIframe

Définit s’il faut afficher un logo lorsque le nouveau Signer Experience est présenté dans un iFrame,

withoutShowNseLogoInIframe (par défaut)

Afficher la page d’aperçu

withShowNseOverview

Définit s’il faut afficher une page d’aperçu avant qu’un signataire ne puisse commencer à signer le paquet.

withoutShowNseOverview (par défaut)

Développer le menu gauche

withLeftMenuExpand

Définit si le menu de gauche sera développé par défaut.

withoutLeftMenuExpand (par défaut)

withoutDocumentToolbarDownloadButton

Boîte de dialogue d'achèvement

withoutDialogOnComplete (par défaut)

withDialogOnComplete

Définit si la boîte de dialogue d'achèvement, qui demande aux signataires s'ils veulent revoir les documents ou quitter le système, s'affiche après la signature.

Personnalisation de l'Signer Experience

L'exemple de code ci-dessous vous montre comment modifier le bloc de paramètres. Chaque paramètre a été décrit ci-dessus.

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.

.withSettings(
    DocumentPackageSettingsBuilder.newDocumentPackageSettings()
        .withInPerson()
        .withOptOutOther()
        .withDeclineOther()
        .withOptOut()
        .withOptOutReason("Decline terms.")
        .withoutLanguageDropDown()
        .hideOwnerInPersonDropDown()
        .disableFirstAffidavit()
        .disableSecondAffidavit()
        .withDecline()
        .withoutWatermark()
        .withCaptureText()
        .withHandOverLinkHref("http://www.google.com")
        .withHandOverLinkText("Exit to site")
        .withHandOverLinkTooltip("You will be redirected to the Google homepage")
        .withDocumentToolbarDownloadButton()
        .withDialogOnComplete()
        .withCeremonyLayoutSettings(
            CeremonyLayoutSettingsBuilder.newCeremonyLayoutSettings()
                .withNavigator()
                .withoutGlobalNavigation()
                .withoutBreadCrumbs()
                .withSessionBar()
                .withTitle()
                .withProgressBar()
                .withoutGlobalDownloadButton()
                .withoutGlobalSaveAsLayoutButton()
                .withLogoSource("http://www.logo-maker.net/images/common/company-logo8.gif")
        )
)

Résultats

Une fois que vous avez terminé la personnalisation de l'Signer Experience vos signataires verront les paramètres de personnalisation et la mise en page que vous avez définis pour eux.

.NET SDK

Pour télécharger l'exemple complet de code, consultez notre site Partage de code.

L'OneSpan Sign Signer Experience peut être personnalisée. En personnalisant l'Signer Experience, vous pouvez intégrer de manière transparente le processus de signature dans votre propre site.

Paramètres du paquet de documents

Le tableau suivant fournit une brève description des paramètres Signer Experience qui peuvent être personnalisés. Notez qu'il n'est pas nécessaire de spécifier l'un de ces paramètres. Si un paramètre n'est pas défini, les valeurs par défaut indiquées ci-dessous seront utilisées.

Nom du paramètre

Méthode de paramétrage des paquets de documents

Description

En personne

withInPerson

Définit si tous les documents d'un paquet doivent être signés sur le même appareil.

withoutInPerson (par défaut)

Propriétaire en personne (liste déroulante)

hideOwnerInPersonDropdown

Lorsque la fonction « en personne » est activée, elle définit si le propriétaire du paquet est présent dans le menu déroulant des signataires.

showOwnerInPersonDropdown (par défaut)

Premier affidavit

disableFirstAffidavit

Lorsque l'option en personne est activée, définit si la première page de l'affidavit est affichée lors du changement de signataire à partir du menu déroulant des signataires.

enableFirstAffidavit (par défaut)

Deuxième affidavit

disableSecondAffidavit

Lorsque l'option en personne est activée, définit si la deuxième page d'affidavit s'affiche lors du changement de signataire à partir du menu déroulant.

enableSecondAffidavit (par défaut)

Décliner

withDecline

Définit si un signataire peut refuser le paquet de documents.

withoutDecline (par défaut)

Raison du déclin

withDeclineReason

Définit une raison de refus prédéfinie pour laquelle un signataire refuse de signer un paquet.

Déclin Autre

withDeclineOther (par défaut)

Permet à un signataire d’entrer une raison différente pour refuser de signer un paquet.

withoutDeclineOther

Empêche un signataire d’entrer une raison différente pour refuser de signer un paquet.

Liste déroulante des langues

withLanguageDropdown (par défaut)

Définit si le menu déroulant des langues de la page Signer Experience est affiché.

withoutLanguageDropdown

Afficher la page d’aide

withShowNseHelp

Définit si une page d’aide sera affichée, où vous pouvez fournir des instructions descriptives, des liens externes du site ou des coordonnées que le signataire peut utiliser pour obtenir des informations ou des instructions supplémentaires.

withoutShowNseHelp (par défaut)

Lien de transfert

withHandOverLinkHref

Remplace le bouton Continuer dans l'Signer Experience. S'il est remplacé, le signataire sera redirigé vers une URL que vous spécifiez.

Lien de transfert Info-bulle

withHandOverLinkHrefTooltip

Définit le texte qui apparaîtra lors du survol du bouton de transfert.

Paramètres de lien de transfert

withHandOverLinkParameters(Sets.newHashSet("PACKAGE", "SIGNER", "STATUS"))

Définit les paramètres qui seront ajoutés à l’URL de transfert. Les options disponibles sont ["PACKAGE", "SIGNER", "STATUS"]. Si laissé vide, aucun paramètre ne sera ajouté.

Redirection automatique du lien de transfert

withHandOverLinkAutoRedirect

Redirige automatiquement le signataire vers la page d’URL de transfert une fois que le signataire a terminé la signature.

withoutHandOverLinkAutoRedirect (par défaut)

Filigrane

withWatermark (par défaut)

Définit si les documents signés sont marqués du logo OneSpan Sign.

withoutWatermark

Texte de capture

withCaptureText (par défaut)

Définit si les documents signés sont estampillés avec la date, l'heure et le nom du signataire à chaque endroit où ils ont été signés.

withoutCaptureText

Navigateur

withNavigator (par défaut)

Affiche le Navigateur. Le Navigateur dirige le signataire vers la prochaine signature disponible.

withoutNavigator

Titre

withTitle (par défaut)

Affiche le titre.

withoutTitle

Barre de progression

withProgressBar (par défaut)

Affiche la barre de progression.

withoutProgressBar

Bouton Télécharger

withDocumentToolbarDownloadButton (par défaut)

Définit si le bouton de téléchargement est disponible.

Afficher le logo dans iFrame

withShowNseLogoInIframe

Définit s’il faut afficher un logo lorsque le nouveau Signer Experience est présenté dans un iFrame,

withoutShowNseLogoInIframe (par défaut)

Afficher la page d’aperçu

withShowNseOverview

Définit s’il faut afficher une page d’aperçu avant qu’un signataire ne puisse commencer à signer le paquet.

withoutShowNseOverview (par défaut)

Développer le menu gauche

withLeftMenuExpand

Définit si le menu de gauche sera développé par défaut.

withoutLeftMenuExpand (par défaut)

withoutDocumentToolbarDownloadButton

Boîte de dialogue d'achèvement

withoutDialogOnComplete (par défaut)

withDialogOnComplete

Définit si la boîte de dialogue d'achèvement, qui demande aux signataires s'ils veulent revoir les documents ou quitter le système, s'affiche après la signature.

Le tableau ci-dessous fournit une brève description des sections de la mise en page qui peuvent être personnalisées. Notez qu'il n'est pas nécessaire de spécifier l'un de ces paramètres. Si un paramètre n'est pas défini, les valeurs par défaut indiquées ci-dessous seront utilisées.

Nom du paramètre

Méthode de mise en place de la cérémonie

Description

Navigateur

withNavigator (par défaut)

Affiche le Navigateur. Le Navigateur dirige le signataire vers la prochaine signature disponible.

withoutNavigator

Navigation mondiale

withGlobalNavigation (par défaut)

Affiche la navigation globale.

withoutGlobalNavigation

Chemins de navigation

withBreadCrumbs (par défaut)

Montre le chemin de la signature.

withoutBreadCrumbs

Barre de session

withSessionBar (par défaut)

Affiche la barre de session.

withoutSessionBar

Titre

withTitle (par défaut)

Affiche le titre

withoutTitle

Barre de progression

withProgressBar (par défaut)

Affiche la barre de progression.

withoutProgressBar

Logo

withLogoSource

Remplace le logo par défaut de OneSpan Sign par un logo personnalisé. Une URL valide du logo personnalisé doit être passée en argument.

Bouton Télécharger

withGlobalDownloadButton (par défaut)

Affiche le bouton Télécharger dans la zone d'actions globales.

withoutGlobalDownloadButton

Bouton Enregistrer sous la mise en page

withGlobalSaveAsLayoutButton (par défaut)

Affiche le bouton Enregistrer en tant que mise en page dans la zone d'actions globale.

withoutGlobalSaveAsLayoutButton

Personnalisation de l'Signer Experience

L'exemple de code ci-dessous vous montre comment modifier le bloc de paramètres. Chaque paramètre a été décrit ci-dessus.

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.

 .withSettings(DocumentPackageSettingsBuilder.newDocumentPackageSettings()
				.withInPerson()
				.withLanguageDropDown()
				.hideOwnerInPersonDropDown()
				.disableFirstAffidavit()
				.disableSecondAffidavit()
				.withDecline()
				.withDeclineOther()
				.withDeclineReason("some reason")
				.withoutWatermark()
				.withoutCaptureText()
				.withoutHandOverLinkAutoRedirect()
				.withHandOverLinkHref("http://www.google.com")
				.withHandOverLinkTooltip("You will redirected to Google homepage")
				.withHandOverLinkParameters(Sets.newHashSet("PACKAGE", "SIGNER", "STATUS"))
				
				.withLeftMenuExpand()
				.withShowNseHelp()
				.withShowNseLogoInIframe()
				.withShowNseOverview()
				.withCeremonyLayoutSettings(CeremonyLayoutSettingsBuilder.newCeremonyLayoutSettings()
							.withoutNavigator()
							.withoutProgressBar()
							.withoutTitle()
							.withGlobalDownloadButton()

Résultats

Une fois que vous avez terminé la personnalisation de l'Signer Experience vos signataires verront les paramètres de personnalisation et la mise en page que vous avez définis pour eux.

API REST

Pour télécharger l'exemple complet de code, consultez notre site Partage de code.

L'OneSpan Sign Signer Experience peut être personnalisée. En personnalisant l'Signer Experience, vous pouvez intégrer de manière transparente le processus de signature dans votre propre site.

Paramètres du paquet de documents

Le tableau suivant fournit une brève description des paramètres Signer Experience qui peuvent être personnalisés.

Nom du paramètre

Méthode de paramétrage des paquets de documents

Description

En personne

paramètres > cérémonie > inPerson

Détermine si tous les documents d'un paquet doivent être signés sur le même appareil.

Liste déroulante Propriétaire en personne

paramètres > cérémonie > hidePackageOwnerInPerson

Lorsque "en personne" est activé, détermine la présence du propriétaire du paquet dans le menu déroulant des signataires.

Premier affidavit

paramètres > cérémonie > disableFirstInPersonAffidavit

Lorsque "en personne" est activé, détermine l'affichage de la première page de l'affidavit lors du changement de signataire à partir du menu déroulant des signataires.

Deuxième affidavit

paramètres > cérémonie > disableSecondInPersonAffidavit

Lorsque "en personne" est activé, détermine l'affichage de la deuxième page d'affidavit, lors du changement de signataire à partir du menu déroulant.

Décliner

paramètres > cérémonie > declineButton

Détermine si un signataire peut refuser le paquet de documents.

Motif du refus

paramètres > cérémonie > declineReasons

Motif de refus prédéfini pour lequel un signataire refuse de signer un paquet.

Décliner Autre

paramètres > cérémonie > disableDeclineOther

Permet à un signataire d’entrer un autre motif de refus de signature d'un paquet.

Liste déroulante des langues

paramètres > cérémonie > hideLanguageDropdown

Détermine l'affichage du menu déroulant des langues à partir de la page Expérience du signataire.

Afficher la page d’aide

paramètres > cérémonie > showNseHelp

Détermine l'affichage d'une page d’aide vous permettant de fournir des instructions descriptives, des liens externes du site ou des coordonnées que le signataire peut utiliser pour obtenir des informations ou des instructions supplémentaires.

Lien de transfert

paramètres > cérémonie > handOver > href

Remplace le bouton Continuer dans Expérience du signataire. S'il est remplacé, le signataire sera redirigé vers une URL que vous aurez spécifiée.

Info-bulle du lien de transfert

paramètres > cérémonie > handOver > titre

Définit le texte qui apparaîtra lorsque l'on passe la souris sur le bouton de transfert.

Paramètres du lien de transfert

paramètres > cérémonie > handOver > paramètres

Définit les paramètres qui seront ajoutés à l’URL de transfert. Les options disponibles sont ["PACKAGE", "SIGNER", "STATUS"]. Si ce champ n'est pas renseigné, aucun paramètre ne sera ajouté.

Redirection automatique du lien de transfert

paramètres > cérémonie > handOver > autoRedirect

Redirige automatiquement le signataire vers la page d’URL de transfert une fois que le signataire a terminé la signature.

Filigrane

paramètres > cérémonie > hideWatermark

Détermine si les documents signés sont estampillés du logo OneSpan Sign .

Texte de capture

paramètres > cérémonie > hideCaptureText

Détermine si les documents signés sont estampillés avec la date, l'heure et le nom du signataire à chaque emplacement de signature.

Navigateur

paramètres > cérémonie > mise en page > navigateur

Affiche le Navigateur. Le Navigateur dirige le signataire vers la prochaine signature disponible.

Titre

paramètres > cérémonie > mise en page > en-tête > titleBar > titre

Affiche le titre.

Bouton Télécharger

paramètres > cérémonie > documentToolbarOptions > downloadButton

Détermine si le bouton de téléchargement est disponible.

Afficher le logo dans l'iFrame

paramètres > cérémonie > showNseLogoInIframe

Détermine l'affichage d'un logo lorsque Nouvelle expérience du signataire est présenté dans un iFrame,

Afficher la page d’aperçu

paramètres > cérémonie > showNseOverview

Détermine l'affichage d'une page d’aperçu avant qu’un signataire ne puisse commencer à signer le paquet.

Développer le menu gauche

paramètres > cérémonie > leftMenuExpand

Détermine si le menu de gauche sera développé par défaut.

Personnalisation de l'Signer Experience

L'exemple JSON ci-dessous vous montre comment modifier l'objet « paramètres ». Chaque méthode a été décrite ci-dessus, dans la section « Paramètres au niveau du paquet de documents ».

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.

Requête HTTP

POST /api/packages

En-têtes HTTP

Accept: application/json
Content-Type: application/json
Authorization: Basic api_key
{
    "name": "Customizing Signer Experience",
    "settings": {
        "ceremony": {
            "events": {
                "complete": {
                    "dialog": true,
                    "redirect": ""
                }
            },
            "inPerson": true,
            "declineButton": true,
            "declineReasons": [],
            "disableDeclineOther": false,
            "disableDownloadForUncompletedPackage": false,
            "disableFirstInPersonAffidavit": true,
            "disableInPersonAffidavit": false,
            "disableOptOutOther": false,
            "disableSecondInPersonAffidavit": true,
            "documentToolbarOptions": {
                "downloadButton": true
            },
            "handOver": {
                "title": "You will be redirected to Google homepage",
                "href": "http://www.google.com",
                "text": "Exit to site"
            },
            "hideCaptureText": false,
            "hideLanguageDropdown": true,
            "hidePackageOwnerInPerson": true,
            "hideWatermark": true,
            "maxAuthFailsAllowed": 3,
            "optOutButton": true,
            "optOutReasons": ["Decline terms."],
            "style": null,
            "layout": {
                "footer": {},
                "navigator": true,
                "brandingBar": {
                    "logo": {
                        "src": "http://www.logo-maker.net/images/common/company-logo8.gif",
                        "link": ""
                    }
                },
                "header": {
                    "feedback": true,
                    "globalActions": {
                        "confirm": true,
                        "download": false,
                        "hideEvidenceSummary": false,
                        "saveAsLayout": false
                    },
                    "titleBar": {
                        "title": true,
                        "progressBar": true
                    },
                    "breadcrumbs": false,
                    "globalNavigation": false,
                    "sessionBar": true
                }
            }
        }
    },
    "type": "PACKAGE",
    "status": "DRAFT"
}

Données utiles de la réponse

 {   
   "id": "9sKhW-h-qS9m6Ho3zRv3n2a-rkI="   
  } 

Résultats

Une fois que vous avez terminé la personnalisation de l'Signer Experience vos signataires verront les paramètres de personnalisation et la mise en page que vous avez définis pour eux.


Cet article vous a-t-il été utile ?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Ozzy, facilitant la découverte de connaissances grâce à l’intelligence conversationnelle