OneSpan Signハウツー:リマインダーの設定

Haris Haidary, 2016年3月1日
Thumbnail

リマインダースケジュールを設定することにより、送信者は、保留中の署名について署名者に通知するタイミングと頻度を選択できます。パッケージが署名のために送信されたときに送信される最初の通知に加えて。つまり、パッケージがまだ完了していない場合、保留中の署名を署名者に思い出させるために、指定された間隔でカスタマイズ可能な数の通知を送信できます。

リマインダースケジュールは、署名用のパッケージが送信される前にのみ作成できます。パッケージが署名用に送信された後、リマインダースケジュールを取得、更新、または削除できます。リマインダースケジュールの設定は、API / SDKを介してのみ実行できることに注意してください。これをWeb UIから探している場合は、有効期限が切れるパッケージのリマインダーの標準スケジュールに従います。

このブログでは、OneSpan Sign Java SDK、.NET SDK、およびREST APIを使用してリマインダースケジュールを設定する方法を紹介します。

OneSpan Sign開発者コミュニティ

OneSpan Sign開発者コミュニティ

OneSpan Sign開発者コミュニティに参加してください!フォーラム、ブログ、ドキュメント、SDKダウンロードなど。

今日参加します

コード

目的がわかったので、コードから始めましょう。それぞれの方法でまったく同じ情報を扱います。該当するセクションに進んでください。このブログの完全なコードは、開発者コミュニティコードシェアにあります。ジャワ 。ネット 、および残り

Java SDK

まず、Java SDKから始めます。以下は、あなたの作成方法のサンプルコードです ReminderSchedule オブジェクト。合格する必要があります packageId オブジェクトをパラメータとして ReminderScheduleBuilder 、要件に合った設定とともに。あなたが必要なので packageId リマインダースケジュールを設定するには、パッケージを作成した後でこれを行う必要がありますが、パッケージを送信する前に、そのため、 createAndSendPackage() パッケージを送信するメソッドは、それを分割する必要があります。

withDaysUntilFirstReminder() メソッドを使用すると、最初のリマインダーを送信する前に一定の日数を待つことができます。これは、署名のためにドキュメントパッケージが送信されたときに送信される最初の通知には影響しません。の withDaysBetweenReminders() メソッドは、リマインダーの頻度を設定します。の withNumberOfRepetitions() メソッドは、OneSpan Signが署名者に送信するリマインダーの数を設定します(最大5つのリマインダー)。構築したら ReminderSchedule オブジェクト、OneSpan Signを呼び出す ReminderService リマインダースケジュールを作成します。

 

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

 

同様に、署名用のドキュメントパッケージを送信したら、新しいを作成してリマインダースケジュールを更新できます。 ReminderSchedule 異なるパラメーターを持つオブジェクトとOneSpan Signの呼び出し ReminderService

eslClient.getReminderService()。updateReminderScheduleForPackage(reminderScheduleToUpdate);

 

を取得することもできます ReminderSchedule OneSpan Signを呼び出すことによるオブジェクト ReminderService 。そうすることにより、署名者に送信されたすべてのリマインダーも取得します。リマインダーはリストとして返されます。以下のサンプルコードでは、各リマインダーの送信日を印刷することを選択しました。

ReminderSchedule reminderSchedule = client.getReminderService()。getReminderScheduleForPackage(packageId); List reminders = reminderSchedule.getReminders(); for(Reminder reminder:reminders){System.out.println(reminder.getSentDate());の場合}

リマインダースケジュールを削除するには、同様にOneSpan Signを呼び出します ReminderService

eslClient.getReminderService()。clearReminderScheduleForPackage(packageId);

 

.NET SDK

次に、.NET SDKについて説明します。以下は、あなたの作成方法のサンプルコードです ReminderSchedule オブジェクト。合格する必要があります packageId オブジェクトをパラメータとして ReminderScheduleBuilder 、要件に合った設定とともに。あなたが必要なので packageId リマインダースケジュールを設定するには、パッケージを作成した後でこれを行う必要がありますが、パッケージを送信する前に、そのため、 CreateAndSendPackage() パッケージを送信するメソッドは、それを分割する必要があります。

WithDaysUntilFirstReminder() メソッドを使用すると、最初のリマインダーを送信する前に一定の日数を待つことができます。これは、署名のためにドキュメントパッケージが送信されたときに送信される最初の通知には影響しません。の WithDaysBetweenReminders() メソッドは、リマインダーの頻度を設定します。の WithNumberOfRepetitions() メソッドは、OneSpan Signが署名者に送信するリマインダーの数を設定します(最大5つのリマインダー)。構築したら ReminderSchedule オブジェクト、OneSpan Signを呼び出す ReminderService リマインダースケジュールを作成します。

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

 

同様に、署名用のドキュメントパッケージを送信したら、新しいを作成してリマインダースケジュールを更新できます。 ReminderSchedule 異なるパラメーターを持つオブジェクトとOneSpan Signの呼び出し ReminderService

eslClient.ReminderService.UpdateReminderScheduleForPackage(reminderScheduleToUpdate);

 

を取得することもできます ReminderSchedule OneSpan Signを呼び出すことによるオブジェクト ReminderService 。そうすることにより、署名者に送信されたすべてのリマインダーも取得します。リマインダーはリストとして返されます。以下のサンプルコードでは、各リマインダーの送信日を印刷することを選択しました。

ReminderSchedule createdReminderSchedule = eslClient.ReminderService.GetReminderScheduleForPackage(packageId); List reminders = createdReminderSchedule.Reminders; foreach(リマインダーのリマインダー){Debug.WriteLine(reminder.SentDate); }

 

リマインダースケジュールを削除するには、同様にOneSpan Signを呼び出します ReminderService

eslClient.ReminderService.ClearReminderScheduleForPackage(packageId);

 

REST API

最後に、REST APIについて説明します。このセクションでは、すべてのリクエストが次のベースURLに対して行われます:https://sandbox.esignlive.com/api/packages/{packageId}/reminders。リマインダースケジュールを作成するには、役職次のJSONの例を使用して、ベースURLへのリクエスト:

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

合格する必要があります packageId パラメータとして、要件に合った設定とともに。の startInDaysDelay パラメータを使用すると、最初のリマインダーを送信する前に一定の日数を待つことができます。これは、署名用にドキュメントパッケージを送信したときに送信される最初の通知には影響しません。の intervalInDays パラメータは、リマインダーの頻度を設定します。の repeatsCount パラメーターは、OneSpan Signが署名者に送信するリマインダーの数を設定します(最大5つのリマインダー)。

同様に、署名用のドキュメントパッケージを送信したら、次のようにしてリマインダースケジュールを更新できます。プット異なるパラメータを使用してベースURLにリクエストします。

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

リマインダースケジュールを取得するには、取得するベースURLへのリクエスト。そうすることにより、署名者に送信されたすべてのリマインダーも取得します。以下は、OneSpan Signによって返されるJSONの例です。

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

リマインダースケジュールを削除するには、削除ベースURLへのリクエスト。

コードを実行する

これで、コードを実行できます。私の例では、署名者に1日に1回リマインダーを送信することを選択しました。以下は、保留中の署名について署名者が受信した通知メールのスクリーンショットです。 

リマインダー

Javaおよび.NET SDKの場合、各リマインダーの送信日をコンソールに出力するコードを含めました。以下は、そのような出力がどのようになるかを示すスクリーンショットです。

コンソール

どうぞ。ドキュメントパッケージのリマインダーを設定しました。このブログや、OneSPan Signをアプリケーションに統合することに関するその他の質問がある場合は、開発者コミュニティフォーラムにアクセスしてください。 https://developer.esignlive.com 。それは私からです。読んでくれてありがとう!この投稿が役に立った場合は、Facebook、Twitter、またはLinkedInで共有してください。

ハリスハイダリー

ジュニアテクニカルエバンジェリスト

LinkedIn | ツイッター