Incorporação

Assinatura incorporada x editor incorporado

A KivoSign oferece dois tipos de incorporação:

• Assinatura incorporada: a tela de assinatura fica dentro do seu sistema. Seus usuários assinam sem sair do seu site.
• Editor incorporado: a criação e edição de documentos e modelos ficam dentro do seu sistema. Veja o guia do Editor.

Esta página trata da assinatura incorporada. Se seus usuários precisam criar ou editar documentos dentro do seu sistema, veja o Editor.

Disponibilidade

A incorporação depende do seu plano. Alguns recursos extras também dependem do plano:

• CSS e variáveis de estilo personalizados
• Controle do modo escuro
• Remoção da marca KivoSign

Em caso de dúvida, fale com suporte@kivosign.com.br.

Como funciona

Há duas formas de incorporar a assinatura, cada uma com um componente e um tipo de token.

Modelos diretos

Modelos diretos são permanentes: cada vez que alguém conclui a assinatura, um novo documento é criado a partir do modelo. É a abordagem recomendada para a maioria dos casos.

Use o componente EmbedDirectTemplate com o token do modelo:

import { EmbedDirectTemplate } from '@documenso/embed-react';

<EmbedDirectTemplate
  host="https://app.kivosign.com.br"
  token="token-do-seu-modelo"
  onDocumentCompleted={(data) => {
    console.log('Assinado:', data.documentId);
  }}
/>;

Tokens de assinatura

Em integrações avançadas, em que você cria os documentos pela API, você pode incorporar a assinatura de um destinatário específico usando o token de assinatura dele.

Use o componente EmbedSignDocument com o token do destinatário:

import { EmbedSignDocument } from '@documenso/embed-react';

<EmbedSignDocument
  host="https://app.kivosign.com.br"
  token="token-de-assinatura-do-destinatario"
  onDocumentCompleted={(data) => {
    console.log('Assinado:', data.documentId);
  }}
/>;

Obtendo o token

Token do modelo direto

Token de assinatura

Os tokens de assinatura vêm nas respostas da API ao distribuir um documento. Você também pode obter um manualmente passando o mouse sobre o avatar de um destinatário em um documento seu e clicando no e-mail dele.

SDKs por framework

Escolha seu framework para começar:

Também existe um SDK de Web Components (@documenso/embed-webcomponent) para usar fora dos frameworks JavaScript. Ele funciona em qualquer ambiente que suporte custom elements.

Se preferir não usar SDK, incorpore a assinatura com Links diretos, usando um iframe simples ou um redirecionamento.

Propriedades

EmbedDirectTemplate

EmbedSignDocument

Assinaturas salvas

Por padrão, quem assina por uma incorporação não tem conta, então cada documento começa com o campo de assinatura vazio. Se a mesma pessoa assina com frequência pelas suas incorporações, passe um clientUserId e a KivoSign lembra a assinatura usada para preencher da próxima vez.

<EmbedSignDocument
  host="https://app.kivosign.com.br"
  token="token-de-assinatura-do-destinatario"
  clientUserId="usr_8f2c1b4e"
/>

Como funciona:

• A assinatura salva é vinculada à sua organização, ao e-mail do destinatário e ao clientUserId informado. O mesmo clientUserId com outro e-mail conta como outro signatário.
• Quando a incorporação carrega com um clientUserId que tem assinatura salva, o campo de assinatura já vem preenchido. O signatário pode apagar e assinar de outro jeito.
• Sempre que o signatário muda a assinatura na incorporação, a nova é salva em segundo plano. O salvamento é feito sem garantias e nunca bloqueia a assinatura.
• Só o desenho/valor da assinatura é guardado. Ele nunca é aplicado a um documento em nome do signatário.

As gravações de assinaturas salvas têm limite por destinatário e por endereço IP. Se o limite for excedido, a atualização é ignorada e a sessão atual do signatário não é afetada.

Eventos

onDocumentCompleted

Recebe um objeto com:

onFieldSigned

Recebe um objeto com:

onFieldUnsigned

Recebe um objeto com:

Mais

Veja também

• API de documentos - Crie documentos por código
• API de modelos - Gerencie modelos pela API
• Webhooks - Receba no servidor os avisos de assinatura