OneSpan Sign How To: Einrichten von Erinnerungen

Haris Haidary, 1. März 2016

Durch Festlegen eines Erinnerungsplans kann ein Absender auswählen, wann und wie oft der / die Unterzeichner über eine ausstehende Signatur benachrichtigt werden soll. Zusätzlich zu der ersten Benachrichtigung, die gesendet wird, sobald das Paket zur Unterzeichnung gesendet wird. Mit anderen Worten, vorausgesetzt, das Paket ist noch nicht fertiggestellt, kann eine anpassbare Anzahl von Benachrichtigungen mit einem festgelegten Intervall zwischen den einzelnen gesendet werden, um Ihre Unterzeichner an eine ausstehende Signatur zu erinnern.

Erinnerungspläne können nur erstellt werden, bevor ein Paket zur Signatur gesendet wird. Nachdem ein Paket zur Signatur gesendet wurde, kann der Erinnerungsplan abgerufen, aktualisiert oder gelöscht werden. Es ist wichtig zu beachten, dass das Festlegen von Erinnerungsplänen nur über die API / SDKs erfolgen kann. Wenn Sie dies über die Web-Benutzeroberfläche anzeigen, wird der Standardplan für Erinnerungen an ein ablaufendes Paket eingehalten.

In diesem Blog werde ich Ihnen zeigen, wie Sie Erinnerungspläne mit dem OneSpan Sign Java SDK, dem .NET SDK und der REST-API einrichten.

OneSpan Sign-Entwickler-Community

OneSpan Sign-Entwickler-Community

Treten Sie der OneSpan Sign Developer Community bei! Foren, Blogs, Dokumentationen, SDK-Downloads und mehr.

Tritt heute bei

Der Code

Nachdem wir unser Ziel kennen, 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. Unten finden Sie einen Beispielcode, wie Sie Ihre erstellen würden ReminderSchedule Objekt. Sie müssen Ihre bestehen packageId Objekt als Parameter zum ReminderScheduleBuilder , zusammen mit den Einstellungen, die Ihren Anforderungen entsprechen. Da brauchst du ein packageId Um Ihren Erinnerungsplan festzulegen, müssen Sie dies tun, nachdem Sie das Paket erstellt haben, aber BEVOR Sie es senden. Wenn Sie also das verwenden createAndSendPackage () Methode, um Ihre Pakete zu senden, müssen Sie es aufteilen.

Das withDaysUntilFirstReminder () Mit dieser Methode können Sie eine bestimmte Anzahl von Tagen warten, bevor Sie die erste Erinnerung senden. Dies hat keine Auswirkungen auf die erste Benachrichtigung, die gesendet wird, sobald Ihr Dokumentpaket zur Signatur gesendet wird. Das withDaysBetweenReminders () Methode legt die Häufigkeit Ihrer Erinnerungen fest. Das withNumberOfRepetitions () Methode legt die Anzahl der Erinnerungen fest, die OneSpan Sign an Ihre Unterzeichner sendet, mit maximal 5 Erinnerungen. Sobald Sie Ihre gebaut haben ReminderSchedule Objekt rufen Sie Ihr OneSpan-Zeichen auf ReminderService um Ihren Erinnerungsplan zu erstellen.

 

ReminderSchedule memorScheduleToCreate = ReminderScheduleBuilder.forPackageWithId (packageId) .withDaysUntilFirstReminder (1) .withDaysBetweenReminders (1) .withNumberOfRepetitions (5) .build (); eslClient.getReminderService (). createReminderScheduleForPackage (memorScheduleToCreate);

 

Sobald Sie Ihr Dokumentpaket zum Signieren gesendet haben, können Sie Ihren Erinnerungsplan aktualisieren, indem Sie ein neues erstellen ReminderSchedule Objekt mit verschiedenen Parametern und Aufruf Ihres OneSpan-Zeichens ReminderService .

eslClient.getReminderService (). updateReminderScheduleForPackage (memorScheduleToUpdate);

 

Sie können auch Ihre abrufen ReminderSchedule Objekt, indem Sie Ihr OneSpan-Zeichen aufrufen ReminderService . Auf diese Weise erhalten Sie auch alle Erinnerungen, die an Ihre Unterzeichner gesendet wurden. Erinnerungen werden als Liste zurückgegeben. Im folgenden Beispielcode habe ich das Versanddatum jeder Erinnerung gedruckt.

ReminderSchedule ErinnerungSchedule = client.getReminderService (). GetReminderScheduleForPackage (packageId); List reminders = memorSchedule.getReminders (); für (Erinnerung Erinnerung: Erinnerungen) {System.out.println (Erinnerung.getSentDate ()); }}

Um Ihren Erinnerungsplan zu löschen, rufen Sie ebenfalls Ihr OneSpan-Zeichen an ReminderService .

eslClient.getReminderService (). clearReminderScheduleForPackage (packageId);

 

.NET SDK

Als nächstes werde ich das .NET SDK behandeln. Unten finden Sie einen Beispielcode, wie Sie Ihre erstellen würden ReminderSchedule Objekt. Sie müssen Ihre bestehen packageId Objekt als Parameter zum ReminderScheduleBuilder , zusammen mit den Einstellungen, die Ihren Anforderungen entsprechen. Da brauchst du ein packageId Um Ihren Erinnerungsplan festzulegen, müssen Sie dies tun, nachdem Sie das Paket erstellt haben, aber BEVOR Sie es senden. Wenn Sie also das verwenden CreateAndSendPackage () Methode, um Ihre Pakete zu senden, müssen Sie es aufteilen.

Das WithDaysUntilFirstReminder () Mit dieser Methode können Sie eine bestimmte Anzahl von Tagen warten, bevor Sie die erste Erinnerung senden. Dies hat keine Auswirkungen auf die erste Benachrichtigung, die gesendet wird, sobald Ihr Dokumentpaket zur Signatur gesendet wird. Das WithDaysBetweenReminders () Methode legt die Häufigkeit Ihrer Erinnerungen fest. Das WithNumberOfRepetitions () Methode legt die Anzahl der Erinnerungen fest, die OneSpan Sign an Ihre Unterzeichner sendet, mit maximal 5 Erinnerungen. Sobald Sie Ihre gebaut haben ReminderSchedule Objekt rufen Sie Ihr OneSpan-Zeichen auf ReminderService um Ihren Erinnerungsplan zu erstellen.

ReminderSchedule memorScheduleToCreate = ReminderScheduleBuilder.ForPackageWithId (packageId) .WithDaysUntilFirstReminder (1) .WithDaysBetweenReminders (1) .WithNumberOfRepetitions (5) .Build (); eslClient.ReminderService.CreateReminderScheduleForPackage (memorScheduleToCreate);

 

Sobald Sie Ihr Dokumentpaket zum Signieren gesendet haben, können Sie Ihren Erinnerungsplan aktualisieren, indem Sie ein neues erstellen ReminderSchedule Objekt mit verschiedenen Parametern und Aufruf Ihres OneSpan-Zeichens ReminderService .

eslClient.ReminderService.UpdateReminderScheduleForPackage (memorScheduleToUpdate);

 

Sie können auch Ihre abrufen ReminderSchedule Objekt, indem Sie Ihr OneSpan-Zeichen aufrufen ReminderService . Auf diese Weise erhalten Sie auch alle Erinnerungen, die an Ihre Unterzeichner gesendet wurden. Erinnerungen werden als Liste zurückgegeben. Im folgenden Beispielcode habe ich das Versanddatum jeder Erinnerung gedruckt.

ReminderSchedule createdReminderSchedule = eslClient.ReminderService.GetReminderScheduleForPackage (packageId); List reminders = createdReminderSchedule.Reminders; foreach (Erinnerung Erinnerung in Erinnerungen) {Debug.WriteLine (Erinnerung.SentDate); }}

 

Um Ihren Erinnerungsplan zu löschen, rufen Sie ebenfalls Ihr OneSpan-Zeichen an ReminderService .

eslClient.ReminderService.ClearReminderScheduleForPackage (packageId);

 

REST-API

Schließlich werde ich die REST-API behandeln. In diesem Abschnitt werden alle Anforderungen an die folgende Basis-URL gesendet: https://sandbox.esignlive.com/api/packages/{packageId}/reminders. Sie können einen Erinnerungsplan erstellen, indem Sie a POST Anforderung an die Basis-URL mit dem folgenden Beispiel-JSON:

{"startInDaysDelay": 1, "repetitionsCount": 5, "intervalInDays": 1, "packageId": "{packageId}"}

Sie müssen Ihre bestehen packageId als Parameter zusammen mit den Einstellungen, die Ihren Anforderungen entsprechen. Das startInDaysDelay Mit diesem Parameter können Sie eine bestimmte Anzahl von Tagen warten, bevor Sie die erste Erinnerung senden. Dies hat keine Auswirkungen auf die erste Benachrichtigung, die gesendet wird, sobald Sie Ihr Dokumentpaket zur Unterzeichnung gesendet haben. Das intervalInDays Parameter legt die Häufigkeit Ihrer Erinnerungen fest. Das repetitionsCount Der Parameter legt die Anzahl der Erinnerungen fest, die OneSpan Sign an Ihre Unterzeichner sendet, mit maximal 5 Erinnerungen.

Sobald Sie Ihr Dokumentpaket zum Signieren gesendet haben, können Sie Ihren Erinnerungsplan aktualisieren, indem Sie eine STELLEN Anfrage an die Basis-URL mit verschiedenen Parametern.

{"startInDaysDelay": 2, "repetitionsCount": 5, "intervalInDays": 3, "packageId": "{packageId}"}

Sie können Ihren Erinnerungsplan abrufen, indem Sie a BEKOMMEN Anfrage an die Basis-URL. Auf diese Weise erhalten Sie auch alle Erinnerungen, die an Ihre Unterzeichner gesendet wurden. Unten finden Sie ein Beispiel für JSON, das von OneSpan Sign zurückgegeben wird.

{"packageId": "ebfcf18f-7bbc-4ff6-a5db-6352dbbfa9f6", "startInDaysDelay": 2, "repetitionsCount": 5, "intervalInDays": 2, "reminders": [{"sentDate": "2016-02- 26T00: 30: 02Z "," Datum ":" 2016-02-25T16: 53: 13Z "}, {" sentDate ":" 2016-02-27T00: 30: 03Z "," Datum ":" 2016-02- 26T16: 53: 13Z "}, {" sentDate ":" 2016-02-28T00: 30: 01Z "," date ":" 2016-02-27T16: 53: 13Z "}, {" sentDate ":" 2016- 02-29T00: 30: 02Z "," Datum ":" 2016-02-28T16: 53: 13Z "}, {" sentDate ": null," Datum ":" 2016-02-29T16: 53: 13Z "}, {"sentDate": null, "date": "2016-03-01T16: 53: 13Z"}]}

Um Ihren Erinnerungsplan zu löschen, erstellen Sie eine LÖSCHEN Anfrage zur Basis-URL.

Ausführen Ihres Codes

Sie können jetzt fortfahren und Ihren Code ausführen. In meinem Beispiel habe ich beschlossen, einmal täglich eine Erinnerung an meinen Unterzeichner zu senden. Unten sehen Sie einen Screenshot der Benachrichtigungs-E-Mails, die mein Unterzeichner für eine ausstehende Unterschrift erhalten hat.  

Erinnerungen

Für die Java- und .NET-SDKs habe ich den Code eingefügt, der das Versanddatum jeder Erinnerung an die Konsole ausgibt. Unten sehen Sie einen Screenshot davon, wie eine solche Ausgabe aussehen würde.

Konsole

Los geht's. Sie haben erfolgreich Erinnerungen für ein Dokumentpaket eingerichtet. 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.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.

Haris Haidary

Junior Technical Evangelist

LinkedIn | Twitter