ZapSign API
Português
Português
  • Informações gerais
  • Como começar
  • Ambiente de testes
  • Todas as requisições prontas!
  • Autenticação
    • Token estático (Api Token)
    • JWT (recomendado)
      • Obter token de acesso
      • Atualize seu token de acesso
  • Tipos de Tokens e Como Localizá-los
  • Versionamento da API
  • Políticas de Rate Limit
  • Alerta de incidentes
  • Ambiente de produção: Como funciona o pagamento
  • Status de erros
  • Conta
    • Informações do Plano
    • Listar usuários da conta
    • Criar usuários na conta
    • Excluir usuário da conta
  • Documentos
    • Criar documento via Upload
    • OneClick (ClickWrap)
      • Criar documento (OneClick)
    • Criar documento via Modelo
    • Adicionar anexo (documento extra)
    • Adicionar anexo (documento extra) via Modelo
    • Detalhar documento
    • Listar documentos
    • Excluir documento
    • Histórico de atividades do documento
    • Opcional: Posicionar assinaturas
    • Reprovar documentos
  • Signatários
    • Detalhar signatário
    • Atualizar signatário
    • Adicionar signatário
    • Excluir signatário
    • Grupo de signatários
      • Definir grupos de signatários
      • Excluir grupos de signatários
    • Assinar em lote via API
    • Reprovar documentos pelo usuário
  • Modelos
    • Criar modelo DOCX
      • Atualizar formulario
    • Listar modelos
    • Detalhar modelo
    • Atualizar modelo
    • Excluir modelo
  • Antecedentes
    • Introdução
    • Entendendo o Resultado
    • Criar uma Consulta (Check)
      • Consulta de Pessoa
      • Consulta de Empresa
  • Consultar Check
  • Detalhe do Check
  • Parcerias
    • Atualizar status de pagamento
  • Criar conta
  • CARIMBO DE TEMPO
    • Como funciona Carimbo de Tempo?
    • Carimbo de Tempo padrão
    • Carimbo de tempo preservando a assinatura original
  • Webhooks
    • Como funcionam os Webhooks
    • Testando Webhooks
    • Criar webhook
    • Logs de Webhooks
    • Eventos
      • Documento
        • Documento criado
        • Documento removido
        • Signatário criado
      • Signatário
        • Notificação de assinatura
        • Documento visualizado
        • Confirmação de leitura
        • Documento assinado
        • Documento recusado
        • Email bounce
        • Falha na Validação
      • Antecedentes
        • Consulta concluída
    • Reprocessamento de Documentos e Webhooks
    • Deletar webhook
  • Widget
    • Como funciona o Widget
Powered by GitBook
On this page
  • Adição do Widget ao seu site
  • Usando Window.onmessage com os Widgets
  • Atributo Allow

Was this helpful?

  1. Widget

Como funciona o Widget

Configure Widgets no seu site de forma rápida e fácil!

Com o widget da ZapSign, você integra a assinatura eletrônica diretamente no seu site, garantindo uma experiência fluida e segura!

Para utilizar o widget, seu aplicativo deve ser uma aplicação web compatível com JavaScript.

Adição do Widget ao seu site

Para incorporar o widget da ZapSign ao seu site, utilize o código HTML fornecido abaixo.

<!DOCTYPE html>
<html>
<head>
	<title>Teste Widget ZapSign</title>
</head>
<body>
        <!-- Atenção: é importante que você inclua o atributo 'allow' no seu iframe para que possamos pedir a foto do signatario ou foto do documento do signatario caso você tenha optado por algum desses métodos de assinatura -->
	<iframe src="https://app.zapsign.com.br/verificar/TOKEN-DO-SIGNATÁRIO" width="100%" height="800px" allow="camera"></iframe>

	<script>		
			window.onmessage = function(e){
	        if(e.data === 'zs-doc-loaded'){
	        	alert('Doc loaded in iframe')
	        }
	        if(e.data === 'zs-doc-signed'){
	        	alert('Doc signed by signer')
	        }
	        if(e.data === 'zs-signed-file-ready'){
	        	alert('Signed file (final pdf) ready to download')
	        }
			};
	</script>

</body>
</html>

Usando Window.onmessage com os Widgets

A função window.onmessage é opcional, mas ajuda a fornecer feedback imediato aos usuários, garantindo uma experiência de assinatura mais rápida e eficiente. Os eventos disponíveis incluem: carregamento do documento, conclusão da assinatura e disponibilidade do arquivo assinado para download.


Atributo Allow

No widget da ZapSign, O atributo allow no elemento <iframe> permite o acesso à câmera do dispositivo quando necessário, como na captura de foto do signatário ou de um documento durante o processo de assinatura. Adicionar allow="camera" garante que o widget possa solicitar a câmera, se essa opção de assinatura estiver habilitada.

Documentos que utilizam autenticação por reconhecimento facial exigem configurações adicionais para garantir a segurança de toda a aplicação. Se precisar dessa funcionalidade ou tiver dúvidas em como incorporá-la em seu fluxo, entre em contato com nossa equipe de suporte através do e-mail support@zapsign.com.br

PreviousDeletar webhook

Last updated 8 months ago

Was this helpful?

Cada signatário possui seu próprio token e a vinculação acontece automaticamente ao criar o documento. Vá para o capítulo para saber mais.

Usuário utilizando o atributo allow no elemento iframe
Tipos de Tokens e Como Localizá-los
Cover

zs-doc-loaded: Indica que o PDF foi carregado na tela do signatário.

Cover

zs-doc-signed: Notifica quando o signatário conclui a assinatura do documento.

Cover

zs-signed-file-ready: Informa que o PDF assinado está pronto para download (neste momento, o botão "baixar assinado" é ativado).

pessoa inserindo um atributo allow dentro do seu iframe para que o usuário final possa utilizar a camera no fluxo de assinatura