OneSpan Sign Como: Personalizando a Cerimônia de Assinatura

Haris Haidary, 9 de Março de 2016

Com o OneSpan Sign, você pode personalizar vários aspectos da cerimônia de assinatura para atender às necessidades do seu aplicativo. Isso permite que você integre mais perfeitamente a experiência de assinatura do eSignLive em seu aplicativo. Neste blog, mostrarei como personalizar a cerimônia de assinatura com o Java SDK, .NET SDK e REST API.

Configurações no nível do pacote de documentos

Antes de entrar no código, darei uma breve descrição de cada pacote disponível e das configurações de layout da cerimônia. É importante observar que não é necessário especificar nenhuma dessas configurações. Eles serão padronizados com os valores mostrados abaixo, se não especificados. Configurações do pacote de documentos [ID da tabela = 3 /] Configurações de layout da cerimônia Abaixo está o layout padrão da cerimônia de assinatura do OneSpan Sign. Cada uma das seções é rotulada por conveniência.  

Configurações do pacote de documentos

Nome da configuração Método de configurações do pacote de documentos Descrição
Em pessoa withInPerson Se todos os documentos em um pacote precisam ser assinados no mesmo dispositivo.
withoutInPerson (padrão)
Excluir withOptOut (padrão) Permita que um assinante não participe da cerimônia de assinatura.
withoutOptOut
Motivo da desativação withOptOutReason Se um assinante decide optar por não participar, ele / ela pode selecionar um motivo para sua retirada.
Menu suspenso de idiomas withLanguageDropdown (padrão) Se o menu suspenso de idioma da página da cerimônia de assinatura é exibido.
withoutLanguageDropdown
Lista suspensa do proprietário pessoalmente hideOwnerInPersonDropdown Quando pessoalmente estiver ativado, decida se o pacote é proprietário ou não, no menu suspenso signatário.
showOwnerInPersonDropdown (padrão)
Primeira declaração disableFirstAffidavit Quando pessoalmente estiver ativado, decida se a primeira página de depoimento será exibida ao trocar de assinante no menu suspenso.
enableFirstAffidavit (padrão)
Segunda declaração disableSecondAffidavit Quando pessoalmente estiver ativado, decida se a segunda página de depoimento será mostrada ao trocar de assinante no menu suspenso.
enableSecondAffidavit (padrão)
Declínio withDecline Se um assinante pode recusar o pacote de documentos.
withoutDecline (padrão)
Marca d'água withWatermark (padrão) Se os documentos assinados são carimbados com o logotipo do OneSpan Sign em cada assinatura.
withoutWatermark
Capturar texto withCaptureText Se os documentos assinados estão sendo carimbados com a data, hora e nome do assinante em cada local em que foram assinados.
withoutCaptureText (padrão)
Link de entrega withHandOverLinkHref Substitui o botão continuar na cerimônia de assinatura. O usuário será redirecionado para um URL que você especificar.
withHandOverLinkText O texto que aparecerá no botão de entrega.
withHandOverLinkTooltip O texto que aparecerá ao passar o mouse sobre o botão de entrega.
Botão Download withDocumentToolbarDOwnloadButton (padrão) Se o botão de download está disponível.
withoutDocumentToolbarDownloadButton
Diálogo concluído withoutDialogOnComplete (padrão)
withDialogOnComplete Se a caixa de diálogo de conclusão, que pergunta aos assinantes se eles desejam revisar os documentos ou deixar o sistema, é mostrada após a assinatura.

Configurações de layout da cerimônia

Abaixo está o layout padrão da cerimônia de assinatura do OneSpan Sign. Cada uma das seções é rotulada por conveniência.

esl_overview

Nome da configuração Método de configurações de layout de cerimônia Descrição
Navegador withNavigator (padrão) Mostre o navegador. Ele direciona o assinante para a próxima assinatura disponível.
withoutNavigator
Navegação Global com Navegação Global (padrão) Mostra a navegação global.
withoutGlobalNavigation
Migalhas de pão withBreadCrumbs (padrão) Mostre as migalhas de pão.
withoutBreadCrumbs
Barra de sessão withSessionBar (padrão) Mostre a barra de sessões.
withoutSessionBar
Título withTitle (padrão) Mostrar o título
withoutTitle
Barra de progresso withProgressBar (padrão) Mostre a barra de progresso.
withoutProgressBar
IFrame withIFrame Se a cerimônia de assinatura está incorporada em um iFrame.
withoutIFrame (padrão)
Logotipo withLogoSource Substitui o logotipo padrão do OneSpan Sign por um logotipo personalizado. Um URL válido para o logotipo personalizado precisa ser passado como argumento.
Botão de confirmação global withGlobalConfirmButton (padrão) Mostrar botão de confirmação na área de ações globais.
withoutGlobalConfirmButton
Botão Download withGlobalDownloadButton (padrão) Mostre o botão de download na área de ações globais.
withoutGlobalDownloadButton
Botão Salvar como layout withGlobalSaveAsLayoutButton (padrão) Mostre o botão "Salvar como layout" na área de ações globais.
withoutGlobalSaveAsLayoutButton

O código

Como mencionei acima, mostrarei como personalizar a cerimônia de assinatura com o Java SDK, .NET SDK e REST API. Vá em frente e pule para a seção que se aplica ao seu método. Vou cobrir as mesmas informações em cada segmento. O código completo deste blog pode ser encontrado no compartilhamento da comunidade de desenvolvedores: Java , .INTERNET e DESCANSAR .

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

Java SDK

Vou começar com o Java SDK. O código de exemplo abaixo mostra como editar o bloco de configurações. Se você precisar de uma comparação com a criação básica do objeto de documento ou se for a primeira vez que cria um pacote com o Java SDK, consulte este procedimento anterior. blogue .

.withSettings (DocumentPackageSettingsBuilder.newDocumentPackageSettings ()
			.withInPerson ()
			.withOptOut ()
			.withOptOutReason ("Recusar termos.")
			.withoutLanguageDropDown ()
			.hideOwnerInPersonDropDown ()
			.disableFirstAffidavit ()
			.disableSecondAffidavit ()
			.withDecline ()
			.withoutWatermark ()
			.withCaptureText ()
			.withHandOverLinkHref ("http://www.google.com")
			.withHandOverLinkText ("Sair para o site")
			.withHandOverLinkTooltip ("Você será redirecionado para a página inicial do Google")
			.withDocumentToolbarDownloadButton ()
			.withDialogOnComplete ()							
.withCeremonyLayoutSettings (CeremonyLayoutSettingsBuilder.newCeremonyLayoutSettings ()
				.withNavigator ()
				.withoutGlobalNavigation ()
				.withoutBreadCrumbs ()
				.withSessionBar ()
				.withTitle ()
				.withProgressBar ()
				.withIFrame ()
				.withGlobalConfirmButton ()
				.withoutGlobalDownloadButton ()
				.withoutGlobalSaveAsLayoutButton ()
				.withLogoSource ("http://www.logo-maker.net/images/common/company-logo8.gif")))

.NET SDK

A seguir, abordarei o .NET SDK. O código de exemplo abaixo mostra como editar o bloco de configurações. Se você precisar de uma comparação com a criação básica de objeto de documento ou se for a primeira vez que cria um pacote com o .NET SDK, consulte isso anteriormente blogue .

.WithSettings (DocumentPackageSettingsBuilder.NewDocumentPackageSettings ()
                        .WithInPerson ()
                        .WithOptOut ()
                        .WithOptOutReason ("Recusar termos.")
                        .WithoutLanguageDropDown ()
                        .HideOwnerInPersonDropDown ()
                        .DisableFirstAffidavit ()
                        .DisableSecondAffidavit ()
                        .WithDecline ()
                        .WithoutWatermark ()
                        .WithCaptureText ()
                        .WithHandOverLinkHref ("http://www.google.com")
                        .WithHandOverLinkText ("Sair para o site")
 			.WithHandOverLinkTooltip ("Você será redirecionado para a página inicial do Google")
                        .WithoutDocumentToolbarDownloadButton ()
                        .WithoutDialogOnComplete ()
              .WithCeremonyLayoutSettings (CeremonyLayoutSettingsBuilder.NewCeremonyLayoutSettings ()
                                .WithNavigator ()
                                .WithoutGlobalNavigation ()
                                .WithoutBreadCrumbs ()
                                .WithSessionBar ()
                                .WithTitle ()
                                .WithProgressBar ()
                                .WithIFrame ()
                                .WithGlobalConfirmButton ()
                                .WithoutGlobalDownloadButton ()
                                .WithoutGlobalSaveAsLayoutButton ()
                                .WithLogoImageSource ("http://www.logo-maker.net/images/common/company-logo8.gif")))

API REST

Por fim, abordarei a API REST. A amostra JSON abaixo mostra como editar o objeto de configurações. Incluí que criará um novo pacote de documentos com configurações de exemplo por conveniência. Se você precisar de uma comparação com a criação básica do objeto de documento ou se for a primeira vez que cria um pacote com a API REST, consulte esta seção anterior. blogue .

{
  "configurações": {
    "cerimônia": {
      "eventos": {
        "completo": {
          "dialog": true,
          "redirecionar": ""
        }
      }
      "inPerson": true,
      "declButton": true,
      "declinationReasons": [],
      "disableDeclineOther": false,
      "disableDownloadForUncompletedPackage": false,
      "disableFirstInPersonAffidavit": true,
      "disableInPersonAffidavit": false,
      "disableOptOutOther": false,
      "disableSecondInPersonAffidavit": true,
      "documentToolbarOptions": {
        "downloadButton": true
      }
      "entregar": {
        "title": "Você será redirecionado para a página inicial do Google",
        "href": "http://www.google.com",
        "text": "Sair para o site"
      }
      "hideCaptureText": false,
      "hideLanguageDropdown": true,
      "hidePackageOwnerInPerson": true,
      "hideWatermark": true,
      "maxAuthFailsAllowed": 3,
      "optOutButton": true,
      "optOutReasons": [
        "Recusar termos".
      ],
      "estilo": nulo,
      "layout": {
        "rodapé": {},
        "iframe": true,
        "navegador": true,
        "brandingBar": {
          "logo": {
            "src": "/sites/default/files/blog/images/company-logo8.gif",
            "ligação": ""
          }
        }
        "cabeçalho": {
          "feedback": verdadeiro,
          "globalActions": {
            "confirmar": verdadeiro,
            "download": falso,
            "hideEvidenceSummary": false,
            "saveAsLayout": false
          }
          "Barra de titulo": {
            "title": true,
            "progressBar": true
          }
          "farinha de rosca": false,
          "globalNavigation": false,
          "sessionBar": true
        }
      }
    }
  }
  "type": "PACOTE",
  "status": "DRAFT",
  "name": "Personalizando a cerimônia de assinatura"
}

Executando seu código

Agora você pode prosseguir e executar seu código. Dependendo das configurações escolhidas, o resultado final pode ser diferente do meu. Se você seguiu meu exemplo, abaixo está uma captura de tela do que você pode esperar:

resultados

Ai está. Você personalizou com êxito a cerimônia de assinatura.

Se você tiver dúvidas sobre este blog ou qualquer outra coisa relacionada à integração do OneSpan Sign ao seu aplicativo, visite os fóruns da comunidade de desenvolvedores:

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