OneSpan Sign Cómo: configurar recordatorios

Haris Haidary, 1 de Marzo de 2016

Al establecer un horario de recordatorio, un remitente puede elegir cuándo y con qué frecuencia notificar al firmante sobre una firma pendiente; Además de la notificación inicial enviada en el momento en que se envía el paquete para su firma. En otras palabras, suponiendo que el paquete aún no se haya completado, se puede enviar un número personalizable de notificaciones con un intervalo especificado entre cada una para recordarle a su firmante de una firma pendiente.

Los horarios de recordatorio solo se pueden crear antes de enviar un paquete para su firma. Después de enviar un paquete para su firma, se puede recuperar, actualizar o eliminar el calendario de recordatorios. Es importante tener en cuenta que la programación de recordatorios solo se puede hacer a través de API / SDK. Si está buscando esto a través de la interfaz de usuario web, se sigue el calendario estándar de recordatorios de un paquete que expira.

En este blog, le mostraré cómo configurar horarios de recordatorio con OneSpan Sign Java SDK, .NET SDK y REST API.

Comunidad de desarrolladores de OneSpan Sign

Comunidad de desarrolladores de OneSpan Sign

¡Únase a la comunidad de desarrolladores de OneSpan Sign! Foros, blogs, documentación, descargas de SDK y más.

Únete hoy

El código

Ahora que conocemos nuestro objetivo, comencemos con el código. Cubriré exactamente la misma información para cada método. Siéntase libre de pasar a la sección que le corresponde. El código completo de este blog se puede encontrar en el código compartido de la comunidad de desarrolladores: Java , .RED y DESCANSO .

SDK de Java

Comenzaré con el SDK de Java. A continuación se muestra un código de muestra sobre cómo crearía su Recordatorio objeto. Necesitarás pasar tu packageId objeto como un parámetro para el ReminderScheduleBuilder , junto con la configuración que se adapte a sus necesidades. Ya que necesitas un packageId para establecer su calendario de recordatorios, deberá hacerlo DESPUÉS de haber creado el paquete, pero ANTES de enviarlo, por lo que si está utilizando el createAndSendPackage () Para enviar sus paquetes, deberá dividirlos.

los withDaysUntilFirstReminder () El método le permite esperar una cierta cantidad de días antes de enviar el primer recordatorio. Esto no afectará la notificación inicial enviada en el momento en que se envía su paquete de documentos para su firma. los withDaysBetweenReminders () El método establece la frecuencia de sus recordatorios. los withNumberOfRepetitions () El método establece el número de recordatorios que OneSpan Sign enviará a sus firmantes, con un máximo de 5 recordatorios. Una vez que hayas construido tu Recordatorio objeto, usted llama a su OneSpan Sign Recordatorio para crear su calendario de recordatorios.

 

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

 

Del mismo modo, una vez que haya enviado su paquete de documentos para firmar, puede actualizar su calendario de recordatorios creando un nuevo Recordatorio objeto con diferentes parámetros y llamando a su OneSpan Sign Recordatorio .

eslClient.getReminderService (). updateReminderScheduleForPackage (reminderScheduleToUpdate);

 

También puedes recuperar tu Recordatorio objetar llamando a su OneSpan Sign Recordatorio . Al hacerlo, también recibirá todos los recordatorios que se han enviado a su firmante (s). Los recordatorios se devuelven como una lista. En el código de ejemplo a continuación, elegí imprimir la fecha de envío de cada recordatorio.

ReminderSchedule reminderSchedule = client.getReminderService (). GetReminderScheduleForPackage (packageId); List <reminder> reminders = reminderSchedule.getReminders (); for (Recordatorio recordatorio: recordatorios) {System.out.println (reminder.getSentDate ()); }</reminder>

Para eliminar su calendario de recordatorios, también debe llamar a su OneSpan Sign Recordatorio .

eslClient.getReminderService (). clearReminderScheduleForPackage (packageId);

 

.NET SDK

A continuación, cubriré el SDK de .NET. A continuación se muestra un código de muestra sobre cómo crearía su Recordatorio objeto. Necesitarás pasar tu packageId objeto como un parámetro para el ReminderScheduleBuilder , junto con la configuración que se adapte a sus necesidades. Ya que necesitas un packageId para establecer su calendario de recordatorios, deberá hacerlo DESPUÉS de haber creado el paquete, pero ANTES de enviarlo, por lo que si está utilizando el CreateAndSendPackage () Para enviar sus paquetes, deberá dividirlos.

los WithDaysUntilFirstReminder () El método le permite esperar una cierta cantidad de días antes de enviar el primer recordatorio. Esto no afectará la notificación inicial enviada en el momento en que se envía su paquete de documentos para su firma. los WithDaysBetweenReminders () El método establece la frecuencia de sus recordatorios. los WithNumberOfRepetitions () El método establece el número de recordatorios que OneSpan Sign enviará a sus firmantes, con un máximo de 5 recordatorios. Una vez que hayas construido tu Recordatorio objeto, usted llama a su OneSpan Sign Recordatorio para crear su calendario de recordatorios.

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

 

Del mismo modo, una vez que haya enviado su paquete de documentos para firmar, puede actualizar su calendario de recordatorios creando un nuevo Recordatorio objeto con diferentes parámetros y llamando a su OneSpan Sign Recordatorio .

eslClient.ReminderService.UpdateReminderScheduleForPackage (reminderScheduleToUpdate);

 

También puedes recuperar tu Recordatorio objetar llamando a su OneSpan Sign Recordatorio . Al hacerlo, también recibirá todos los recordatorios que se han enviado a su firmante (s). Los recordatorios se devuelven como una lista. En el código de ejemplo a continuación, elegí imprimir la fecha de envío de cada recordatorio.

ReminderSchedule createdReminderSchedule = eslClient.ReminderService.GetReminderScheduleForPackage (packageId); Lista <reminder> recordatorios = createdReminderSchedule.Reminders; foreach (Recordatorio recordatorio en recordatorios) {Debug.WriteLine (reminder.SentDate); }</reminder>

 

Para eliminar su calendario de recordatorios, también debe llamar a su OneSpan Sign Recordatorio .

eslClient.ReminderService.ClearReminderScheduleForPackage (packageId);

 

API REST

Finalmente, cubriré la API REST. En esta sección, todas las solicitudes se realizan a la siguiente URL base: https://sandbox.esignlive.com/api/packages/{packageId}/reminders. Puede crear un calendario de recordatorios haciendo un ENVIAR solicitud a la URL base con el siguiente ejemplo JSON:

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

Necesitarás pasar tu packageId como parámetro junto con la configuración que se adapte a sus necesidades. los startInDaysDelay El parámetro le permite esperar una cierta cantidad de días antes de enviar el primer recordatorio. Esto no afectará la notificación inicial enviada en el momento en que envió su paquete de documentos para su firma. los intervalInDays El parámetro establece la frecuencia de sus recordatorios. los repeticiones El parámetro establece el número de recordatorios que OneSpan Sign enviará a sus firmantes, con un máximo de 5 recordatorios.

Del mismo modo, una vez que haya enviado su paquete de documentos para firmar, puede actualizar su calendario de recordatorios haciendo un PONER solicitud a la URL base con diferentes parámetros.

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

Puede recuperar su calendario de recordatorios haciendo un OBTENER solicitud a la URL base. Al hacerlo, también recibirá todos los recordatorios que se han enviado a su firmante (s). A continuación se muestra un ejemplo de JSON devuelto por OneSpan Sign.

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

Para eliminar su calendario de recordatorios, realice un ELIMINAR solicitud de URL base.

Ejecutando su código

Ahora puede seguir adelante y ejecutar su código. En mi ejemplo, he elegido enviar un recordatorio a mi firmante una vez al día. A continuación se muestra una captura de pantalla de los correos electrónicos de notificación recibidos por mi firmante para una firma pendiente.  

recordatorios

Para los SDK de Java y .NET, he incluido el código que imprime la fecha de envío de cada recordatorio a la consola. A continuación se muestra una captura de pantalla de cómo se vería tal salida.

consola

Ahí tienes. Ha configurado correctamente recordatorios para un paquete de documentos. Si tiene preguntas sobre este blog o cualquier otra cosa relacionada con la integración de OneSPan Sign en su aplicación, visite los foros de la comunidad de desarrolladores: https://developer.esignlive.com . Eso es todo de mi parte. ¡Gracias por leer! Si esta publicación le parece útil, compártala en Facebook, Twitter o LinkedIn.

Haris Haidary

Evangelista Técnico Junior

LinkedIn El | Gorjeo