Mise en place de OneSpan Sign’s Event Notifier
Ce blog vous guidera à travers le Notificateur d’événements qui a été introduit dans les versions 10.13.14 et 11.0.5 de OneSpan Sign. Lors de l’intégration de la cérémonie de signature de OneSpan Sign dans un iframe, le Notificateur d’événements peut envoyer des notifications à l’application hôte parente. Ceci est particulièrement utile si vous voulez prendre des mesures lorsque certaines étapes de la cérémonie de signature ont été accomplies. Après avoir reçu une telle notification, vous pouvez interrompre le flux normal de OneSpan Sign pour effectuer une tâche asynchrone (par exemple, demander à l’utilisateur de confirmer une demande), puis aviser OneSpan Sign de reprendre son flux normal.
Démarrage de l'événement Notificateur
Vous pouvez écrire votre OneSpan Sign Event Notifier en JavaScript. Votre application doit être à l’écoute des événements de message de OneSpan Sign, comme indiqué ci-dessous :
window.addEventListener ('message', receiveMessage, faux);
Pour démarrer votre Notificateur d'événements, votre auditeur devrait être quelque chose dans ce sens :
fonction recevoirMessage (événement) var origine 'event.origin' event.originalEvent.origin; données var -event.data; console.log (données, origine); commutateur (données) cas 'ESL:MESSAGE:REGISTER': event.source.postMessage ('ESL:MESSAGE:ACTIVATE_EVENTS', origine); pause; Par défaut: event.source.postMessage (données, origine) pause; } }
Lors du chargement d’une page dans un iframe, OneSpan Sign va d’abord tirer un événement ESL:MESSAGE:REGISTER. En retour, votre demande doit renvoyer à OneSpan Sign l’événement ESL:MESSAGE:ACTIVATE_EVENTS. Si cela ne se produit pas, OneSpan Sign supposera que personne n’écoute, et aucun autre événement ne sera déclenché.
Interrompre le flux normal d’activité du signe OneSpan
Certains événements peuvent être temporairement arrêtés (les événements en question sont identifiés dans la troisième colonne du tableau ci-dessous). Par exemple, vous pouvez modifier l'auditeur ci-dessus comme suit :
commutateur (données) cas 'ESL:MESSAGE:REGISTER': event.source.postMessage ('ESL:MESSAGE:ACTIVATE_EVENTS', origine); pause; cas 'ESL:MESSAGE:SUCCESS:SIGNER_COMPLETE': event.source.postMessage ('ESL:MESSAGE:SUCCESS:SIGNER_COMPLETE', origine); $("#myIframe"). cacher iframe window.location.href -"https://www.google.com"; rediriger vers google pause; Par défaut: event.source.postMessage (données, origine) pause; }
Dans le code ci-dessus, le signataire sera redirigé vers la page d'accueil de Google dans la fenêtre parent (c'est-à-dire pas à l'intérieur de l'iframe) une fois qu'il/elle aura terminé la signature des documents. Note: Si les événements ne sont pas renvoyés au fur et à mesure qu’ils sont reçus, OneSpan Sign ne reprendra pas son activité normale.
Types d'événements de notification
Le tableau suivant décrit les types d'événements de notification que votre auditeur d'événements peut écouter.
Nom de l’événement | Description | L'événement peut-il être temporairement arrêté? | Compatible avec la cérémonie de signature standard? | Compatible avec la cérémonie de signature mobile? |
ESL:MESSAGE:STARTED:DOCUMENT_ACCEPT | Un signataire a commencé à accepter un consentement ou une divulgation. | N° | Oui | Oui |
ESL:MESSAGE:SUCCESS:DOCUMENT_ACCEPT | Un signataire a accepté avec succès un consentement ou une divulgation. | Oui | Oui | Oui |
ESL:MESSAGE:ERROR:DOCUMENT_ACCEPT | Un signataire a échoué dans sa tentative d'accepter un consentement ou une divulgation. | N° | Oui | Oui |
ESL:MESSAGE:STARTED:PACKAGE_OPT_OUT | Un signataire a commencé à se retirer d'une transaction. | N° | Oui | Oui |
ESL:MESSAGE:SUCCESS:PACKAGE_OPT_OUT | Un signataire s'est désisté avec succès d'une transaction. | Oui | Oui | Oui |
ESL:MESSAGE:ERROR:PACKAGE_OPT_OUT | Un signataire a échoué dans sa tentative de se retirer d'une transaction. | N° | Oui | Oui |
ESL:MESSAGE:STARTED:PACKAGE_DECLINE | Un signataire a commencé à refuser une transaction. | N° | Oui | N° |
ESL:MESSAGE:SUCCESS:PACKAGE_DECLINE | Un signataire a refusé avec succès une transaction. | Oui | Oui | N° |
ESL:MESSAGE:ERROR:PACKAGE_DECLINE | Un signataire a échoué dans sa tentative de refuser une transaction. | N° | Oui | N° |
ESL:MESSAGE:STARTED:DOCUMENT_CONFIRM | Un signataire a commencé à confirmer un document. | N° | Oui | Oui |
ESL:MESSAGE:SUCCESS:DOCUMENT_CONFIRM | Un signataire a confirmé avec succès un document. | Oui | Oui | Oui |
ESL:MESSAGE:ERROR:DOCUMENT_CONFIRM | Un signataire a échoué dans sa tentative de confirmer un document. | N° | Oui | Oui |
ESL:MESSAGE:STARTED:SIGNER_COMPLETE | Un signataire a commencé à effectuer une transaction. | Oui | Oui | Oui |
ESL:MESSAGE:SUCCESS:SIGNER_COMPLETE | Un signataire a conclu avec succès une transaction. | N° | Oui | Oui |
ESL:MESSAGE:STARTED:DOCUMENT_NAVIGATION | L'utilisateur a commencé à naviguer vers un autre document. | Oui | Oui | Oui |
ESL:MESSAGE:SUCCESS:DOCUMENT_NAVIGATION | L'utilisateur a réussi à naviguer vers un autre document. | N° | Oui | Oui |
Vous pouvez télécharger un exemple de travail complet à partir du Developer Community Code Share.
Si vous avez des questions concernant ce blog ou toute autre chose concernant l'intégration oneSpan Sign dans votre application, visitez les forums de la communauté des développeurs: developer.esignlive.com. C'est moi qui l'ai fait. Merci de lire! Si vous avez trouvé ce message utile, s'il vous plaît le partager sur Facebook, Twitter, ou LinkedIn.
Haris Haidary
Évangéliste technique junior
LinkedIn - France Twitter (en)