OneSpan Sign Como: Configurar lembretes

Haris Haidary, 1 de Março de 2016

Ao definir uma programação de lembrete, o remetente pode escolher quando e com que frequência notificar o (s) assinante (s) sobre uma assinatura pendente; além da notificação inicial enviada no momento em que o pacote é enviado para assinatura. Em outras palavras, supondo que o pacote ainda não tenha sido concluído, um número personalizável de notificações pode ser enviado com um intervalo especificado entre cada um para lembrar seus assinantes de uma assinatura pendente.

As agendas de lembrete só podem ser criadas antes que um pacote seja enviado para assinatura. Depois que um pacote é enviado para assinatura, a programação do lembrete pode ser recuperada, atualizada ou excluída. É importante observar que a configuração de agendamentos de lembrete só pode ser feita através das API / SDKs. Se você estiver procurando por isso na interface da Web, seguirá a programação padrão dos lembretes de um pacote expirado.

Neste blog, mostrarei como configurar agendamentos de lembrete com o OneSpan Sign Java SDK, .NET SDK e REST API.

Comunidade de desenvolvedores OneSpan Sign

Comunidade de desenvolvedores OneSpan Sign

Participe da comunidade de desenvolvedores do OneSpan Sign! Fóruns, blogs, documentação, downloads de SDK e muito mais.

Junte-se hoje

O código

Agora que conhecemos nosso objetivo, vamos começar com o código. Vou cobrir exatamente as mesmas informações para cada método. Sinta-se livre para pular para a seção que se aplica a você. O código completo deste blog pode ser encontrado no compartilhamento da comunidade de desenvolvedores: Java , .INTERNET e DESCANSAR .

Java SDK

Vou começar com o Java SDK. Abaixo está um código de exemplo de como você criaria seu ReminderSchedule objeto. Você precisará passar seu packageId objeto como um parâmetro para o ReminderScheduleBuilder , juntamente com as configurações que atendem às suas necessidades. Desde que você precisa de um packageId para definir sua programação de lembretes, você precisará fazer isso DEPOIS de criar o pacote, mas ANTES de enviá-lo, portanto, se você estiver usando o createAndSendPackage () Para enviar seus pacotes, você precisará dividi-lo.

o withDaysUntilFirstReminder () O método permite aguardar uma certa quantidade de dias antes de enviar o primeiro lembrete. Isso não afetará a notificação inicial enviada no momento em que seu pacote de documentos for enviado para assinatura. o withDaysBetweenReminders () O método define a frequência dos seus lembretes. o withNumberOfRepetitions () O método define o número de lembretes que o OneSpan Sign enviará ao (s) assinante (s), com no máximo 5 lembretes. Depois de criar seu ReminderSchedule objeto, você chama seu OneSpan Sign ReminderService para criar sua agenda de lembretes.

 

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

 

Da mesma forma, depois de enviar seu pacote de documentos para assinatura, você pode atualizar sua programação de lembretes criando um novo ReminderSchedule objeto com parâmetros diferentes e chamando seu OneSpan Sign ReminderService .

eslClient.getReminderService (). updateReminderScheduleForPackage (reminderScheduleToUpdate);

 

Você também pode recuperar seu ReminderSchedule objeto chamando seu OneSpan Sign ReminderService . Ao fazer isso, você também receberá todos os lembretes enviados aos seus assinantes. Os lembretes são retornados como uma lista. No código de exemplo abaixo, escolhi imprimir a data de envio de cada lembrete.

ReminderSchedule reminderSchedule = client.getReminderService (). GetReminderScheduleForPackage (packageId); Listar lembretes = reminderSchedule.getReminders (); for (lembrete de lembrete: lembretes) {System.out.println (reminder.getSentDate ()); }

Para excluir sua programação de lembretes, você também deve ligar para o seu OneSpan Sign ReminderService .

eslClient.getReminderService (). clearReminderScheduleForPackage (packageId);

 

.NET SDK

A seguir, abordarei o .NET SDK. Abaixo está um código de exemplo de como você criaria seu ReminderSchedule objeto. Você precisará passar seu packageId objeto como um parâmetro para o ReminderScheduleBuilder , juntamente com as configurações que atendem às suas necessidades. Desde que você precisa de um packageId para definir sua programação de lembretes, você precisará fazer isso DEPOIS de criar o pacote, mas ANTES de enviá-lo, portanto, se você estiver usando o CreateAndSendPackage () Para enviar seus pacotes, você precisará dividi-lo.

o WithDaysUntilFirstReminder () O método permite aguardar uma certa quantidade de dias antes de enviar o primeiro lembrete. Isso não afetará a notificação inicial enviada no momento em que seu pacote de documentos for enviado para assinatura. o WithDaysBetweenReminders () O método define a frequência dos seus lembretes. o WithNumberOfRepetitions () O método define o número de lembretes que o OneSpan Sign enviará ao (s) assinante (s), com no máximo 5 lembretes. Depois de criar seu ReminderSchedule objeto, você chama seu OneSpan Sign ReminderService para criar sua agenda de lembretes.

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

 

Da mesma forma, depois de enviar seu pacote de documentos para assinatura, você pode atualizar sua programação de lembretes criando um novo ReminderSchedule objeto com parâmetros diferentes e chamando seu OneSpan Sign ReminderService .

eslClient.ReminderService.UpdateReminderScheduleForPackage (reminderScheduleToUpdate);

 

Você também pode recuperar seu ReminderSchedule objeto chamando seu OneSpan Sign ReminderService . Ao fazer isso, você também receberá todos os lembretes enviados aos seus assinantes. Os lembretes são retornados como uma lista. No código de exemplo abaixo, escolhi imprimir a data de envio de cada lembrete.

ReminderSchedule createdReminderSchedule = eslClient.ReminderService.GetReminderScheduleForPackage (packageId); Listar lembretes = createdReminderSchedule.Reminders; foreach (lembrete de lembrete em lembretes) {Debug.WriteLine (reminder.SentDate); }

 

Para excluir sua programação de lembretes, você também deve ligar para o seu OneSpan Sign ReminderService .

eslClient.ReminderService.ClearReminderScheduleForPackage (packageId);

 

API REST

Por fim, abordarei a API REST. Nesta seção, todas as solicitações são feitas para o seguinte URL base: https://sandbox.esignlive.com/api/packages/{packageId}/reminders. Você pode criar uma programação de lembretes fazendo uma POSTAR solicitação para a URL base com o seguinte exemplo JSON:

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

Você precisará passar seu packageId como parâmetro, juntamente com as configurações que atendem às suas necessidades. o startInDaysDelay O parâmetro permite aguardar alguns dias antes de enviar o primeiro lembrete. Isso não afetará a notificação inicial enviada no momento em que você enviou seu pacote de documentos para assinatura. o intervalInDays O parâmetro define a frequência dos seus lembretes. o repetitionsCount O parâmetro define o número de lembretes que o OneSpan Sign enviará ao (s) assinante (s), com no máximo 5 lembretes.

Da mesma forma, depois de enviar seu pacote de documentos para assinatura, você pode atualizar sua programação de lembretes fazendo uma COLOCAR solicitação para o URL base com parâmetros diferentes.

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

Você pode recuperar sua programação de lembretes fazendo uma OBTER solicitação para o URL base. Ao fazer isso, você também receberá todos os lembretes enviados aos seus assinantes. Abaixo está um exemplo JSON retornado pelo OneSpan Sign.

{"packageId": "ebfcf18f-7bbc-4ff6-a5db-6352dbbfa9f6", "startInDaysDelay": 2, "repetitionsCount": 5, "intervalInDays": 2, "lembretes": [{"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"}]}

Para excluir sua programação de lembretes, faça uma EXCLUIR solicitação para URL base.

Executando seu código

Agora você pode prosseguir e executar seu código. No meu exemplo, decidi enviar um lembrete ao meu assinante uma vez por dia. Abaixo está uma captura de tela dos e-mails de notificação recebidos pelo meu assinante para uma assinatura pendente.  

lembretes

Para os SDKs Java e .NET, incluí o código que imprime a data de envio de cada lembrete para o console. Abaixo está uma captura de tela de como seria essa saída.

console

Ai está. Você configurou com êxito lembretes para um pacote de documentos. Se você tiver dúvidas sobre este blog ou qualquer outra coisa relacionada à integração do OneSPan Sign em seu aplicativo, visite os fóruns da comunidade de desenvolvedores: https://developer.esignlive.com . É isso de mim. Obrigado pela leitura! Se você achou esta publicação útil, compartilhe-a no Facebook, Twitter ou LinkedIn.

Haris Haidary

Evangelista Técnico Júnior

LinkedIn | Twitter