OneSpan Sign How To: Absender verwalten

Haris Haidary, 15. März 2016

Mit OneSpan Sign können Sie Ihrem Konto Absender hinzufügen und Dokumentpakete zur Signatur erstellen und senden. Als Kontoinhaber haben Sie Zugriff auf die von Ihren Absendern erstellten Pakete. Sie können die von Ihren Absendern erstellten Pakete jedoch nur über die SDKs / API abrufen. Wenn Sie über die Benutzeroberfläche auf die von Ihren Absendern erstellten Pakete zugreifen möchten, müssen Ihre Absender den Zugriff an Sie delegieren. Dies gilt auch für die umgekehrte Situation. Weitere Informationen zum Delegieren des Zugriffs finden Sie hier vorheriger Blog .

Es gibt drei Arten von Absendern: Eigentümer, Administrator und Basisabsender. Der Eigentümer ist der Kontoinhaber und kann nicht geändert werden. Ein Administrator kann Benutzer einladen, Absender im Konto zu sein, und Absender als Administratoren festlegen. Alle Kontotypen können Pakete erstellen und senden. Es ist auch wichtig zu beachten, dass ein Absender nur Mitglied eines Kontos sein kann. In diesem Blog werde ich Ihnen zeigen, wie Sie Ihre Absender mit dem OneSpan Sign Java SDK, dem .NET SDK und der REST-API verwalten.

Absender in der Benutzeroberfläche

Bevor Sie mit dem Code beginnen, sollten Sie Ihren Absenderabschnitt in Ihrer Benutzeroberfläche suchen. Klicken Sie nach der Anmeldung bei Ihrem OneSpan Sign-Konto in Ihrer Symbolleiste auf KONTO und dann auf die Registerkarte Absender. Nachdem Sie Ihren Code ausgeführt haben, sollten Sie Ihre Absender hier finden.

Der Code

Nachdem unser Ziel festgelegt ist, beginnen wir mit dem Code. Ich werde für jede Methode genau die gleichen Informationen behandeln. Fühlen Sie sich frei, zu dem Abschnitt zu springen, der für Sie gilt. Den vollständigen Code für dieses Blog finden Sie in der Entwickler-Community-Code-Freigabe: Java , .NETZ , und SICH AUSRUHEN . Java SDK Ich werde mit dem Java SDK beginnen. Um einen Benutzer als Absender in Ihr Konto einzuladen, müssen Sie einen erstellen AccountMember Objekt. Dann rufen Sie Ihr OneSpan-Zeichen an AccountService um die Einladung zu senden. Wenn ein neuer Absender zur Teilnahme an einem Konto eingeladen wird, werden diese standardmäßig in einem inaktiven Status hinzugefügt. Der Absender erhält eine E-Mail mit einem Link, auf den er klicken muss, um sein Konto zu aktivieren. Sie können den Überprüfungsschritt überspringen, indem Sie den Status auf setzen AKTIV beim bauen deines AccountMember Objekt, wenn Ihr Absender bereits über ein OneSpan Sign-Konto verfügt.

AccountMember member = AccountMemberBuilder.newAccountMember ("john.smith @example .com ")
				.withFirstName ("John")
				.withLastName ("Smith")
				.withCompany ("ABC Bank")
				.withTitle ("CEO")
				.withStatus (SenderStatus.ACTIVE)
				.bauen();
		
client.getAccountService (). invadeUser (Mitglied);

Sie können Ihre Absender auch abrufen, indem Sie Ihr OneSpan-Zeichen aufrufen AccountService . Im Folgenden finden Sie einen Beispielcode zum Abrufen aller Absender, der als Seite von OneSpan Sign geliefert wird, sowie deren E-Mails und IDs. Die Absender-ID ist erforderlich, um einen Absender zu aktualisieren oder zu löschen. Im folgenden Code ist die Anzahl der Absender angegeben, die in der PageRequest ist auf 5 eingestellt. Die maximale Anzahl von Absendern, die Sie pro Seite abrufen können, beträgt 50. Der erste Wert in der PageRequest (Variable 'i') ist der Ausgangspunkt in der Gesamtliste der Absender, die zurückgegeben werden sollen. Diese Variable wird erhöht, wenn wir unsere Absender durchlaufen, um zu verfolgen, wo wir uns in der Gesamtliste der Absender befinden

int i = 1;
Map  accountMembers = client.getAccountService (). GetSenders (Direction.ASCENDING, new PageRequest (i, 5));
		
während ( !accountMembers .ist leer()) {
für (Map.Entry  -Eintrag: accountMembers.entrySet ())
	{
		System.out.println (entry.getKey () + "/" + entry.getValue (). GetId ());
		i ++;
	}
accountMembers = client.getAccountService (). getSenders (Direction.ASCENDING, neue PageRequest (i, 5));
}

Wie oben erwähnt, benötigen Sie die Absender-ID, um Ihren Absender zu aktualisieren. Beachten Sie, dass die E-Mail-Adresse nicht aktualisiert werden kann, sobald Sie Ihren Absender erstellt haben. In diesem Fall müssen Sie einen neuen Absender erstellen.

SenderInfo aktualisiertSenderInfo = SenderInfoBuilder.newSenderInfo ("john.smith @example .com ")
                .withName ("John", "Smith")
                .withTitle ("CEO")
                .withCompany ("XYZ Bank")
                .bauen();
 
client.getAccountService (). updateSender (updatedSenderInfo, "{senderId}");

client.getAccountService (). deleteSender ("{senderId}");

Im Folgenden finden Sie einen Beispielcode, wie Sie ein Dokumentpaket erstellen, das von einem bestimmten Absender aus Ihrem Konto gesendet wird:

DocumentPackage packageToSend = PackageBuilder.newPackageNamed ("Beispiel für einen Reinigungsvertrag")
			.withSenderInfo (SenderInfoBuilder.newSenderInfo ("john.smith") @example .com "))
			.withSigner (SignerBuilder.newSignerWithEmail ("mary.doe @example .com ")
					.withFirstName ("Mary")
					.withLastName ("Doe")
					.withCustomId ("client"))
			.withSigner (SignerBuilder.newSignerWithEmail ("john.smith @example .com ")
					.withFirstName ("John")
					.withLastName ("Smith")
					.withCustomId ("Auftragnehmer"))
			.withDocument (DocumentBuilder.newDocumentWithName ("Contract.pdf")
					.fromStream (neuer FileInputStream ("DOC_FILE_PATH"), DocumentType.PDF)
					.enableExtraction ())
				.bauen();

.NET SDK Als nächstes werde ich mit dem .NET SDK fortfahren. Um einen Benutzer als Absender in Ihr Konto einzuladen, müssen Sie einen erstellen AccountMember Objekt. Dann rufen Sie Ihr OneSpan-Zeichen an AccountService um die Einladung zu senden. Wenn ein neuer Absender zur Teilnahme an einem Konto eingeladen wird, werden diese standardmäßig in einem inaktiven Status hinzugefügt. Der Absender erhält eine E-Mail mit einem Link, auf den er klicken muss, um sein Konto zu aktivieren. Sie können den Überprüfungsschritt überspringen, indem Sie den Status auf setzen AKTIV beim bauen deines AccountMember Objekt, wenn Ihr Absender bereits über ein OneSpan Sign-Konto verfügt.

AccountMember member = AccountMemberBuilder.NewAccountMember ("price9872 @gmail .com ")
				.WithFirstName ("John")
				.WithLastName ("Smith")
				.WithCompany ("ABC Bank")
				.WithTitle ("CEO")
				.WithStatus (SenderStatus.ACTIVE)
				.Bauen();
		
client.AccountService.InviteUser (Mitglied);

Sie können Ihre Absender auch abrufen, indem Sie Ihr OneSpan-Zeichen aufrufen AccountService . Im Folgenden finden Sie einen Beispielcode zum Abrufen aller Absender, der als Seite von OneSpan Sign geliefert wird, sowie deren E-Mails und IDs. Die Absender-ID wird benötigt, um einen Absender zu aktualisieren oder zu löschen. Im folgenden Code ist die Anzahl der Absender angegeben, die in der PageRequest ist auf 5 eingestellt. Die maximale Anzahl von Absendern, die Sie pro Seite abrufen können, beträgt 50. Der erste Wert in der PageRequest (Variable 'i') ist der Ausgangspunkt in der Gesamtliste der Absender, die zurückgegeben werden sollen. Diese Variable wird erhöht, wenn wir unsere Absender durchlaufen, um zu verfolgen, wo wir uns in der Gesamtliste der Absender befinden

int i = 1;
IDictionary  accountMembers = client.AccountService.GetSenders (Direction.ASCENDING, new PageRequest (i, 5));

while (accountMembers.Count! = 0)
{
foreach (KeyValuePair  -Eintrag in accountMembers)
      	{
        		Debug.WriteLine (entry.Key + "/" + entry.Value.Id);
                i ++;
       	}
      	accountMembers = client.AccountService.GetSenders (Direction.ASCENDING, neue PageRequest (i, 5));
}

SenderInfo aktualisiertSenderInfo = SenderInfoBuilder.NewSenderInfo ("john.smith @example .com ")
                .WithName ("John", "Smith")
                .WithTitle ("CEO")
                .WithCompany ("XYZ Bank")
                .Bauen();
 
client.AccountService.UpdateSender (aktualisierteSenderInfo, "{senderId}");

client.AccountService.DeleteSender ("{senderId}");

Im Folgenden finden Sie einen Beispielcode, wie Sie ein Dokumentpaket erstellen, das von einem bestimmten Absender aus Ihrem Konto gesendet wird:

DocumentPackage packageToSend = PackageBuilder.NewPackageNamed ("Beispiel für einen Reinigungsvertrag")
                .WithSenderInfo (SenderInfoBuilder.NewSenderInfo ("john.smith") @example .com "))
                .WithSigner (SignerBuilder.NewSignerWithEmail ("mary.doe @example .com ")
                        .WithFirstName ("Mary")
                        .WithLastName ("Doe")
                        .WithCustomId ("client"))
                .WithSigner (SignerBuilder.NewSignerWithEmail ("john.smith @example .com ")
                        .WithFirstName ("John")
                        .WithLastName ("Smith")
                        .WithCustomId ("Auftragnehmer"))
                .WithDocument (DocumentBuilder.NewDocumentNamed ("Contract.pdf")
                        .FromStream (neuer FileStream ("DOC_FILE_PATH", FileMode.Open), DocumentType.PDF)
                        .EnableExtraction ())
                .Bauen();

REST-API

Zuletzt werde ich die REST-API durchgehen. Um einen Benutzer als Absender in Ihr Konto einzuladen, müssen Sie den folgenden JSON erstellen. Dann machst du deine POST Anfrage zu: https://sandbox.onespan.com/api/account/senders . Wenn ein neuer Absender zur Teilnahme an einem Konto eingeladen wird, werden diese standardmäßig in einem inaktiven Status hinzugefügt. Der Absender erhält eine E-Mail mit einem Link, auf den er klicken muss, um sein Konto zu aktivieren. Sie können den Überprüfungsschritt überspringen, indem Sie den Status auf setzen AKTIV Wenn Ihr Absender beim Erstellen Ihres JSON bereits über ein OneSpan Sign-Konto verfügt.

[code language = "javascript"] {"email": "john.smith @example .com "," Vorname ":" John "," Nachname ":" Smith "," Firma ":" ABC Bank "," Titel ":" CEO "," Status ":" AKTIV "}

Sie können Ihre Absender auch abrufen, indem Sie a BEKOMMEN Anfrage zu: https://sandbox.onespan.com/api/account/senders?from=0&to=10 . In meinem Beispiel habe ich meine ersten 10 Absender abgerufen. Sie können die Abfrageparameter nach Ihren Wünschen anpassen. Weitere Informationen zu den verfügbaren Abfrageparametern finden Sie in unserem Dokumentation .

Um Ihren Absender zu aktualisieren, benötigen Sie Ihre Absender-ID, die Sie aus der obigen Anfrage abrufen können. Beachten Sie, dass die E-Mail-Adresse nicht aktualisiert werden kann, sobald Sie Ihren Absender erstellt haben. In diesem Fall müssen Sie einen neuen Absender erstellen. Um Ihren Absender zu aktualisieren, erstellen Sie eine POST Anfrage zu https://sandbox.onespan.com/api/account/senders/{senderId} mit folgendem JSON:

[code language = "javascript"] {"Vorname": "John", "Nachname": "Smith", "Firma": "XYZ Bank", "Titel": "CEO",}

Ebenso benötigen Sie die Absender-ID, um Ihren Absender zu löschen. Wenn Ihr Absender Pakete in seinem Posteingang oder im Entwurfsstatus hat, wird der Absender gesperrt, anstatt gelöscht zu werden, und kann keine Pakete erstellen oder senden. Um Ihren Absender zu löschen, müssen Sie LÖSCHEN Anfrage zu: https://sandbox.onespan.com/api/account/senders/{senderId} .

Im Folgenden finden Sie ein Beispiel für JSON, wie Sie ein Dokumentpaket erstellen, das von einem bestimmten Absender aus Ihrem Konto gesendet wird:

[code language = "javascript"] {"sender": {"email": "john.smith @example .com "}," Dokumente ": [{" Extrahieren ": wahr," Name ":" Vertrag "}]," Status ":" ENTWURF "," Rollen ": [{" ID ":" Auftragnehmer "," Geben Sie ":" SENDER "," signers ": [{" email ":" john.smith "ein @example .com "," Vorname ":" John "," Nachname ":" Smith "," ID ":" Auftragnehmer "}]," Name ":" Auftragnehmer "}, {" ID ":" Kunde "," Typ ":" SIGNER "," signers ": [{" email ":" mary.doe @example .com "," firstName ":" Mary "," lastName ":" Doe "," id ":" client "}]," name ":" client "}]," type ":" PACKAGE "," name ":" Beispiel für einen Reinigungsvertrag "}

Ausführen Ihres Codes

Sie können jetzt fortfahren und Ihren Code ausführen. Sie sollten in der Lage sein, Ihre neu erstellten Absender in Ihrem OneSpan Sign-Konto anzuzeigen, wie im Abschnitt "Absender in der Benutzeroberfläche" angegeben. Für die Java- und .NET-SDKs habe ich den Code eingefügt, mit dem die Absender-E-Mails und -IDs ausgedruckt werden. Unten sehen Sie einen Screenshot, wie die Ausgabe aussieht.

Erfassung

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: https://developer.onespan.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.

Haris Haidary
Junior Technical Evangelist
LinkedIn | Twitter

.NETZ API Blog C # Code Entwickler eSignLive anleitungen Java REST SDK Lernprogramm

Haris Haidary

OneSpan Blog

OneSpan Sign How To: Absender verwalten

Absender in der Benutzeroberfläche

Der Code

OneSpan Sign-Entwickler-Community

Ausführen Ihres Codes

OneSpan Sign How To: Erstellen einer Vorlage

E-Signatur-Integration - Ein wichtiges Auswahlkriterium

Tipps und Tricks: So extrahieren Sie Signaturfelder mithilfe von Text-Tags in OneSpan Sign automatisch