Développeurs de panneaux OneSpan : modèles d'e-mail - Partie 1

Duo Liang, décembre 16, 2020

Grâce aux puissantes capacités de valorisation de la marque et d'étiquetage en marque blanche offertes par OneSpan Sign, vous pouvez complètement étiqueter en marque blanche chaque aspect du processus de signature électronique, y compris la personnalisation du contenu et de l'apparence de vos notifications par e-mail. En personnalisant l'objet, le logo et la visibilité des éléments dans le corps du message, chacun de ces modèles d'e-mail peut être personnalisé pour chaque langue prise en charge par OneSpan Sign

Dans ce blog, nous allons suivre un flux de travail normal pour adapter les modèles d'e-mails à votre marque. Sans plus attendre, commençons !

12-16-1

ÉTAPE 1 : Liste des modèles d'e-mails

OneSpan Sign propose un large éventail de modèles d'e-mails pour notifier les destinataires ou les expéditeurs dans différents scénarios. Notre première étape consiste à obtenir une liste complète des modèles d'e-mails disponibles et à lire la description respective de chaque modèle d'e-mail. Cela vous permet de comprendre le cas d'utilisation de chaque modèle et de choisir ceux qui sont les mieux adaptés à vos besoins. Vous trouverez ci-dessous quelques-uns des modèles d'e-mails les plus fréquemment utilisés :

"email.activate" : L'email automatique envoyé à tous les signataires d'un paquet après qu'il ait été envoyé pour signature. Si un paquet est configuré avec un ordre de signature, les signataires recevront un courriel d'invitation lorsque le signataire précédent aura terminé la signature.
"email.notify" : Renvoie une invitation par courriel à examiner ou à signer un paquet après que l'invitation initiale ait rebondi.
"email.complete" : Envoie un email à tous les signataires une fois que tous les signataires ont terminé le processus de signature.
"email.transaction.complete" : Ce modèle envoie un e-mail au propriétaire d'une transaction pour l'informer que tous les signataires ont terminé le processus de signature.

ÉTAPE 2 : Personnalisez l'e-mail

Une fois que vous avez choisi le modèle d'e-mail à personnaliser, la documentation énumère également l'objet et le corps de l'e-mail par défaut, ainsi qu'un certain nombre de variables de remplacement telles que "$RECIPIENT_NAME ;", "$RECIPIENT_ROLE ;", "$PACKAGE_NAME ;", "$LINK_URL ;", "$PACKAGE_MESSAGE ;", etc. Les valeurs de ces espaces sont déterminées dynamiquement pendant l'exécution. En plaçant ces espaces dans l'objet ou le corps du message, vous disposez d'une plus grande souplesse lors de la construction du contenu

Dans cette section, je vais vous expliquer comment ajouter des messages électroniques supplémentaires lors de la création de paquets avec le SDK et l'API REST. Cette valeur sera ensuite transmise à l'espace réservé "$PACKAGE_MESSAGE ;" dans votre modèle "email.activate"

12-16-2

Vous pouvez soit spécifier le message électronique au niveau du paquet, qui est envoyé par défaut à tous les signataires, soit le remplacer au niveau du signataire et fournir des valeurs différentes aux destinataires

SDK

DocumentPackage pkg = PackageBuilder.newPackageNamed("Example Package " + System.currentTimeMillis()) .withEmailMessage("Ceci est un message électronique au niveau du paquet.")
        .withSignerBuilder(SignerBuilder.newSignerWithEmail("[email protected]") .withEmailMessage("Ceci est un message électronique de niveau signataire pour signer2.")
            ...... ) ...... .build() ;

API REST

{ "roles" : [ { "emailMessage" : { "content" : "This is a signer level email message for signer1."
      }, "id" : "Role1", "signers" : [ { "email" : "[email protected]", "firstName" : "1.firstname", "lastName" : "1.lastname", "company" : "OneSpan Sign" } ] }, "name" : "Example Package", "type" : "PACKAGE", "language" : "en", "emailMessage" : "This is a package level email message",
  "description" : "Nouveau paquet", "autocomplete" : true, "status" : "DRAFT" }

Après avoir envoyé la transaction, voici ce à quoi votre signataire peut s'attendre dans le courriel de notification qu'il a reçu.

12-16-3

Note :

Il est important de savoir que chaque modèle prend en charge différentes variables. Par exemple, (1) tous les modèles de courrier électronique ne contiennent pas le paramètre "$LINK_URL ;", (2) l'espace réservé "$RECIPIENT_NAME ;" peut faire référence à un destinataire ou à l'expéditeur en fonction du contexte, etc

ÉTAPE 3 : Soumettre un ticket d'assistance

Pour l'instant, la personnalisation des e-mails ne peut pas être réalisée par le biais des API/SDK. Vous devrez donc envoyer une demande en ce sens à notre équipe d'assistance

Note :

OneSpan Sign prend en charge les courriels en texte brut et les courriels en HTML. Cependant, la conception, le développement et le test complet des courriels en HTML, ainsi que la vérification de leur compatibilité avec les clients, ne font pas partie de l'assistance.
Les modèles d'e-mails se situent au niveau du compte et non du paquet. En d'autres termes, toute personnalisation affectera tous les paquets créés ultérieurement

Grâce au blog d'aujourd'hui, vous devriez savoir où trouver la documentation concernant la personnalisation de l'e-mail, comment placer des espaces réservés dans votre modèle et passer des valeurs dans la création de paquets.

Si vous avez des questions concernant ce blog ou toute autre question relative à l'intégration de OneSpan Sign dans votre application, visitez les forums de la communauté des développeurs. Vos commentaires sont importants pour nous!