Documentação

Migração da API 1.9 para 3.0

⚠️

Importante: A API 1.9 é uma API legada, portanto não receberá mais atualizações ou melhorias.
Todas as evoluções da plataforma estão sendo direcionadas exclusivamente para a versão 3.0 (Envelope).


Por que migrar?

Migrar para a 3.0 não é só atualizar a integração — é evoluir para um modelo que facilita debug, traz mais flexibilidade no envio e aumenta a segurança.

O que você ganha com a migração

Mais flexibilidade nos seus processos

Configure assinaturas com flexibilidade.!

Envie 100 contratos para diferentes para 100 pessoas em um único disparo, com total controle sobre quem assina o quê. Cada pessoa acessa apenas o documento atribuído a ela.

Economia de tempo

Redução significativa no tempo de configuração do envio massivo de documentos para diferentes signatários, com diferentes autenticações, qualificações e configurações.

Novas funcionalidades exclusivas

Documentoscopia, biometria facial com verificação governamental, assinatura posicionada, comprovante de endereço, usuário observador, e outras funcionalidades disponíveis apenas na 3.0!

Segurança aprimorada

Solicite uma análise forense para comprovar autenticidade do documento de quem assina, e verifique sua biometria facial em bases governamentais através das nossas novas autenticações, garantindo mais segurança ao seu processo de assinatura.


O que muda na prática

FuncionalidadeAPI Lote 1.9API Envelope 3.0
Flexibilidade de documentos

Todos assinam todos os documentos

✔ Cada pessoa assina apenas os documentos designados

Estrutura dos endpoints

URLs menos padronizadas

✔ Padrão REST mais consistente

Autenticações

Obrigatoriedade do uso de autenticações primárias

✔ Autenticações flexíveis

Retorno de erros

Respostas genéricas em muitos casos

✔ Códigos e mensagens mais descritivas

Recursos disponíveis

Funcionalidades limitadas

✔ Novas funcionalidades exclusivas

Suporte e evolução

Sem novas melhorias

✔ Atualizações contínuas

Estrutura padronizada

Não possui

✔ Sim, baseada no JSON:API

Suporte nativo a filtros e sort

Manual

✔ Padrão: filter[], sort=


Como a migração resolve problemas do dia a dia

Contrato com múltiplos documentos

"Preciso enviar um contrato principal + 3 documentos para 5 pessoas diferentes, cada uma assinando documentos específicos"

<Columns>
  <div class="rm-card-dark-red" style={{ padding: '0.5rem', flex: '1' }}>
    <i class="Card-icon fa-duotone fa-solid fa-close" style={{ '--Card-icon-color': 'red' }}></i> 			             <strong className="ml-8">Com a API 1.9:</strong>

    * 4 envios separados
    * Configuração individual para cada documento
    * Impossível corrigir erros sem reenviar tudo
    * Processo demorado e burocrático
  </div>

  <div style={{padding: '0.5rem', flex: '1'}} className="rm-card-dark-green">
    <i class="Card-icon fa-duotone fa-solid fa-square-check" style={{ '--Card-icon-color': 'green' }}></i> 		      <strong className="ml-8">Com a API 3.0:</strong>

    * 1 único envelope
    * Configuração centralizada
    * Possível corrigir enquanto o envelope estiver em processo
    * Mais agilidade e flexibilidade
  </div>
</Columns>

Processo corporativo com aprovações

"Contrato que precisa passar por aprovação do jurídico, assinatura do diretor e depois do cliente"

<Columns>
  <div class="rm-card-dark-red" style={{ padding: '0.5rem', flex: '1' }}>
    <i class="Card-icon fa-duotone fa-solid fa-close" style={{ '--Card-icon-color': 'red' }}></i>

    <strong className="ml-8">Com a API 1.9:</strong>

    * Gerenciamento manual da sequência
    * Múltiplos sistemas para acompanhar
    * Retrabalho se houver mudanças
    * Tempo: Semanas
  </div>

  <div style={{ padding: '0.5rem', flex: '1'}} className="rm-card-dark-green">
    <i class="Card-icon fa-duotone fa-solid fa-square-check" style={{ '--Card-icon-color': 'green' }}></i>     	     <strong className="ml-8">Com a API 3.0:</strong>

    * Fluxo automatizado no envelope
    * Acompanhamento centralizado
    * Usuário observador (jurídico)
    * Tempo: Dias
  </div>
</Columns>

Funcionalidades exclusivas

Ao migrar para a API 3.0, você garante acesso a funcionalidades exclusivas que aumentam a segurança e a flexibilidade das suas jornadas de assinatura:

🔍 **Documentoscopia**

Usufrua de uma análise forense das diversas características de um documento, com o objetivo de comprovar sua autenticidade e reduzir riscos de fraude.

🧑‍💻 Biometria facial com verificação em bases oficiais

Obtenha uma camada extra de segurança, com validação biométrica vinculada à uma base governamental (Serpro).

✍️ Assinatura posicionada

Configure os locais de assinatura e rubrica para cada signatário no documento.

📬 Comprovante de endereço

Solicite o envio de um comprovante de endereço para o seu signatário.

👁️ Usuário observador

Inclua pessoas que acompanham o processo de assinatura, sem a necessidade de assinarem o documento.


Pronto para os próximos passos?

Agora que você entendeu os novos benefícios, é hora de começar a implementação. Acesse o nosso guia:

Guia de migração



❓Precisa de ajuda? Entre em contato com o Suporte

💰Dúvida sobre planos e preços? Veja o comparativo

🔍Não sabe qual versão está usando? Descubra a sua versão

📚Respostas rápidas? Visite nosso FAQ

Updated 10 days ago