OneSpan Sign Developer: Rolle gegen Unterzeichner - Teil 2

Duo Liang, 31. Juli 2018
Thumbnail

Letzte Woche haben wir die JSON-Struktur von untersucht Rolle und Unterzeichner , die detaillierte Bedeutung dieser beiden Konzepte sowie die Methoden zum Abrufen von IDs für sie auf REST-Weise. In diesem Blog werde ich Sie durch die Szenarien und API-Aufrufe führen, in denen Sie die Rollen-ID zusammen mit der Unterzeichner-ID verwenden müssen.

Lassen Sie uns zunächst Rolle und Unterzeichner kurz zusammenfassen:

  • Der Unterzeichner enthält die persönlichen Informationen des Benutzers und ist in der Rolle enthalten.
     
  • Die Rolle fungiert als Platzhalter und ist an die Genehmigung (en) gebunden, die aus den Unterschriften und Feldern eines Unterzeichners bestehen.


Wenn Sie immer noch verwirrt sind oder etwas verpasst haben, können Sie in meinem Blog der letzten Woche „OneSpan Sign Developer: Rolle gegen Unterzeichner“ nachsehen oder eine Frage in unserem Entwicklerforum posten.

 

Verwendungszweck der Unterzeichner-ID

Denken Sie daran, dass der Unterzeichner mit der jeweiligen Person verwandt ist. Die E-Mail-Adresse ist die einzige Möglichkeit, einen Unterzeichner eindeutig zu identifizieren, und die Unterzeichner-ID kann durch E-Mail ersetzt werden. Hier sind zwei Szenarien, in denen Sie die Unterzeichner-ID verwenden, in der sie sich an die E-Mail-Adresse des Unterzeichners hält:

 

So rufen Sie den Signaturstatus ab:


OneSpan Sign bietet Ihnen verschiedene Suchkörner für den Signaturstatus. Dies bedeutet, dass Sie den Status für das gesamte Paket oder nur für einen Unterzeichner in einem bestimmten Dokument überprüfen können. Sie können optional Unterzeichner- und Dokumentparameter in der folgenden API-URL auswählen, um dies zu erreichen:

GET / api / packages / {packageId} / testingStatus? Signer = {signerId} & document = {documentId}

 

Auschecken dieser Forumsbeitrag für weitere Details.

 

So rufen Sie das Authentifizierungstoken ab:

 

Ein Authentifizierungstoken wird verwendet, um eine gültige Sitzung für einen Unterzeichner abzurufen oder die Signatur-URL zu generieren.

 

Es gibt drei API-Aufrufe, um authToken für einen Unterzeichner abzurufen:

POST / api / authenticationTokens / signer / singleUse

POST / api / authenticationTokens / signer / multiUse

POST / api / signerAuthenticationTokens

 

Der erste API-Aufruf besteht darin, eine einmalige Verwendung des Authentifizierungstokens zu generieren. Während die letzten beiden APIs die Mehrfachverwendung von authToken generieren, sodass Sie sie als austauschbar betrachten können, werden alle mit derselben Anforderungsnutzlast geliefert:

{

    "packageId": "Ihre Paket-ID",

    "signerId": "Unterzeichner-ID oder Unterzeichner-E-Mail"

}

 

Beachten:

  • Sie können nur dann ein Authentifizierungstoken für Ihren Unterzeichner generieren, wenn sich das Paket im Status "SENT" befindet. Andernfalls erhalten Sie einen "400-Fehler", der erklärt, dass sich dieses Paket in einem ungültigen Zustand befindet.
     
  • Die E-Mail-Adresse des Unterzeichners funktioniert auch in der Anforderungsnutzlast.
     
  • Alle Authentifizierungstoken verfallen in 30 Minuten.
     
  • Sowohl sessionToken (generiert von authToken) als auch authenticationToken können verwendet werden, um eine Signatur-URL für einen Unterzeichner zu generieren, indem der Platzhalter in dieser URL ersetzt wird: https://sandbox.esignlive.com/access?sessionToken={signerAuthToken}


Verwendungszweck der Rollen-ID

Die Rollen-ID wird häufiger verwendet als die Unterzeichner-ID. In unserer API-Spezifikationsseite Hier finden Sie detaillierte Beispiele für Dienste, bei denen die Rollen-ID verwendet wird:

  1. Eine Rolle verwalten
     
  2. Eine Rolle neu anordnen
     
  3. So entsperren Sie einen Unterzeichner
     
  4. So senden Sie eine E-Mail-Einladung zum Signieren
     
  5. So senden Sie einen SMS-Authentifizierungspasscode an einen Unterzeichner

 

Darüber hinaus können Sie die Rollen-ID auch in den folgenden Szenarien verwenden:

 

So generieren Sie die Signatur-URL für einen Unterzeichner


Neben der Verwendung der Signer-ID zum Generieren einer Signatur-URL können Sie auch der folgenden API folgen. Die generierte URL unterscheidet sich von der oben genannten und kann mehrfach verwendet werden. Diese URL entspricht der URL, die der Unterzeichner in seiner E-Mail erhalten würde. Sie möchten diese URL wahrscheinlich nicht in den Quellcode eines Iframes einbetten, da dieser nicht abläuft.

GET / api / packages / {packageId} / role / {roleId} / testingUrl

 

So extrahieren Sie das Signaturbild für einen Unterzeichner

Sobald Ihr Unterzeichner seine Unterschrift erfasst hat, können Sie das Unterschriftenbild herunterladen und zur weiteren Verwendung in Ihrem eigenen System speichern. Die standardmäßig heruntergeladene Bildgröße beträgt 350 x 100 Pixel. Diese Funktion ist nur für Version 11 von OneSpan Sign verfügbar.

HTTP-Anfrage

GET / api / packages / {packageId} / role / {roleId} / SignaturImage

HTTP-Header

Akzeptieren: image / png, image / jpeg, image / gif

Inhaltstyp: application / json

Autorisierung: Basic api_key

 

Wenn Sie Fragen zu diesem Blog oder zu anderen Themen zur Integration von OneSpan Sign in Ihre Anwendung haben, besuchen Sie die Entwickler-Community-Foren . Ihr Feedback ist uns wichtig!