Einrichten der Ereignisbenachrichtigung von OneSpan Sign

Dieser Blog führt Sie durch den Event Notifier, der in den Versionen 10.13.14 und 11.0.5 von OneSpan Sign eingeführt wurde. Beim Einbetten der Signaturzeremonie von OneSpan Sign in einen Iframe kann der Ereignisbenachrichtiger Benachrichtigungen an die übergeordnete Hostanwendung senden. Dies ist besonders nützlich, wenn Sie Maßnahmen ergreifen möchten, wenn bestimmte Schritte der Unterzeichnungszeremonie abgeschlossen wurden. Nachdem Sie eine solche Benachrichtigung erhalten haben, können Sie den normalen Ablauf von OneSpan Sign unterbrechen, um eine asynchrone Aufgabe auszuführen (z. B. den Benutzer bitten, eine Anforderung zu bestätigen), und dann OneSpan Sign benachrichtigen, um den normalen Ablauf fortzusetzen.
Starten des Ereignisbenachrichtigers
Sie können Ihren OneSpan Sign Event Notifier in einfachem JavaScript schreiben. Ihre Anwendung muss die Nachrichtenereignisse von OneSpan Sign abhören, wie unten gezeigt:
window.addEventListener ('message', receiveMessage, false);
Um Ihren Event Notifier zu starten, sollte Ihr Listener ungefähr so aussehen:
Funktion receiveMessage (Ereignis) { var origin = event.origin || event.originalEvent.origin; var data = event.data; console.log (Daten, Herkunft); Schalter (Daten) { Fall 'ESL: MESSAGE: REGISTER': event.source.postMessage ('ESL: MESSAGE: ACTIVATE_EVENTS', Ursprung); brechen; Standard: event.source.postMessage (Daten, Herkunft) brechen; } }
Beim Laden einer Seite in einen Iframe löst OneSpan Sign zunächst ein ESL: MESSAGE: REGISTER-Ereignis aus. Im Gegenzug muss Ihre Anwendung an OneSpan zurücksenden. Signieren Sie das Ereignis ESL: MESSAGE: ACTIVATE_EVENTS. Wenn dies nicht der Fall ist, geht OneSpan Sign davon aus, dass niemand zuhört und keine anderen Ereignisse ausgelöst werden.
Unterbrechen des normalen Aktivitätsflusses von OneSpan Sign
Einige Ereignisse können vorübergehend gestoppt werden (die betreffenden Ereignisse sind in der dritten Spalte der folgenden Tabelle aufgeführt). Sie können den Listener beispielsweise wie folgt ändern:
Schalter (Daten) { Fall 'ESL: MESSAGE: REGISTER': event.source.postMessage ('ESL: MESSAGE: ACTIVATE_EVENTS', Ursprung); brechen; Fall 'ESL: MESSAGE: SUCCESS: SIGNER_COMPLETE': event.source.postMessage ('ESL: MESSAGE: SUCCESS: SIGNER_COMPLETE', Ursprung); // $ ("# myIframe"). hide (); iframe verstecken window.location.href = "https://www.google.com"; // zu Google umleiten brechen; Standard: event.source.postMessage (Daten, Herkunft) brechen; }
Im obigen Code wird der Unterzeichner auf die Google-Startseite im übergeordneten Fenster (dh nicht innerhalb des Iframes) weitergeleitet, sobald er die Dokumente vollständig signiert hat. Hinweis: Wenn Ereignisse beim Empfang nicht zurückgesendet werden, nimmt OneSpan Sign seine normale Aktivität nicht wieder auf.
Benachrichtigungsereignistypen
In der folgenden Tabelle werden die Arten von Benachrichtigungsereignissen beschrieben, die Ihr Ereignis-Listener abhören kann.
Veranstaltungsname | Beschreibung | Kann das Ereignis vorübergehend gestoppt werden? | Kompatibel mit der Standard-Unterzeichnungszeremonie? | Kompatibel mit der Mobile Signing Ceremony? |
ESL: MESSAGE: STARTED: DOCUMENT_ACCEPT | Ein Unterzeichner hat begonnen, eine Einwilligung oder Offenlegung zu akzeptieren. | Nein | Ja | Ja |
ESL: NACHRICHT: ERFOLG: DOCUMENT_ACCEPT | Ein Unterzeichner hat eine Einwilligung oder Offenlegung erfolgreich akzeptiert. | Ja | Ja | Ja |
ESL: MESSAGE: ERROR: DOCUMENT_ACCEPT | Ein Unterzeichner hat bei seinem Versuch, eine Zustimmung oder Offenlegung zu akzeptieren, versagt. | Nein | Ja | Ja |
ESL: MESSAGE: STARTED: PACKAGE_OPT_OUT | Ein Unterzeichner hat begonnen, eine Transaktion zu deaktivieren. | Nein | Ja | Ja |
ESL: MESSAGE: SUCCESS: PACKAGE_OPT_OUT | Ein Unterzeichner hat eine Transaktion erfolgreich abgebrochen. | Ja | Ja | Ja |
ESL: MESSAGE: ERROR: PACKAGE_OPT_OUT | Ein Unterzeichner ist bei dem Versuch, eine Transaktion zu deaktivieren, fehlgeschlagen. | Nein | Ja | Ja |
ESL: MESSAGE: STARTED: PACKAGE_DECLINE | Ein Unterzeichner hat begonnen, eine Transaktion abzulehnen. | Nein | Ja | Nein |
ESL: MESSAGE: SUCCESS: PACKAGE_DECLINE | Ein Unterzeichner hat eine Transaktion erfolgreich abgelehnt. | Ja | Ja | Nein |
ESL: MESSAGE: ERROR: PACKAGE_DECLINE | Ein Unterzeichner ist bei dem Versuch, eine Transaktion abzulehnen, fehlgeschlagen. | Nein | Ja | Nein |
ESL: MESSAGE: STARTED: DOCUMENT_CONFIRM | Ein Unterzeichner hat begonnen, ein Dokument zu bestätigen. | Nein | Ja | Ja |
ESL: MESSAGE: SUCCESS: DOCUMENT_CONFIRM | Ein Unterzeichner hat ein Dokument erfolgreich bestätigt. | Ja | Ja | Ja |
ESL: MESSAGE: ERROR: DOCUMENT_CONFIRM | Ein Unterzeichner hat versucht, ein Dokument zu bestätigen. | Nein | Ja | Ja |
ESL: MESSAGE: STARTED: SIGNER_COMPLETE | Ein Unterzeichner hat begonnen, eine Transaktion abzuschließen. | Ja | Ja | Ja |
ESL: MESSAGE: SUCCESS: SIGNER_COMPLETE | Ein Unterzeichner hat eine Transaktion erfolgreich abgeschlossen. | Nein | Ja | Ja |
ESL: MESSAGE: STARTED: DOCUMENT_NAVIGATION | Der Benutzer hat begonnen, zu einem anderen Dokument zu navigieren. | Ja | Ja | Ja |
ESL: MESSAGE: SUCCESS: DOCUMENT_NAVIGATION | Der Benutzer hat erfolgreich zu einem anderen Dokument navigiert. | Nein | Ja | Ja |
Sie können einen vollständigen Arbeitsbeispielcode aus der Entwickler-Community herunterladen Code-Freigabe .
Wenn Sie Fragen zu diesem Blog oder zu anderen Themen bezüglich der Integration von OneSpan Sign in Ihre Anwendung haben, besuchen Sie die Entwickler-Community-Foren: developer.esignlive.com . Das war's von mir. Danke fürs Lesen! Wenn Sie diesen Beitrag hilfreich fanden, teilen Sie ihn bitte auf Facebook, Twitter oder LinkedIn.