Assinar em lote via API
Last updated
Last updated
Se a sua empresa frequentemente precisa assinar muitos documentos, este endpoint oferece uma maneira eficiente de realizar essas assinaturas sem a necessidade de acessar manualmente cada documento. Com a assinatura em lote, você economiza tempo e automatiza o processo de assinatura de múltiplos documentos! Nesta seção:
O Postman é um grande aliado para assinar rapidamente seus documentos. Comece configurando o endpoint e adicionando seu API Token na aba Authorization. Depois, acesse seu perfil na plataforma para pegar o user token e reúna os signer tokens dos documentos que serão assinados.
POST https://api.zapsign.com.br/api/v1/sign
| Name | Type | Description |
|---|---|---|
Authorization* | string | Api token a frente do texto "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23 |
| Name | Type | Description |
|---|---|---|
user_token* | string | Token do usuário que irá assinar. |
signer_tokens[] | array | Tokens que serão assinados (token do signer em cada documento a ser assinado). |
Exemplos de respostas
Para realizar a assinatura via API, é necessário o user_token do usuário que irá assinar os documentos. Siga os passos abaixo:
Faça login no usuário que irá assinar os documentos.
Entre em Configurações>meu perfil
No final da página, habilite a assinatura via API.
Copie o token gerado e cole no parametro user_token, dentro da request.
Cada signatário (signer) criado na ZapSign possui um token individual. Para obter o token do signatário, siga os passos:
Crie ou acesse um documento.
Adicione o signatário ao documento.
Copie o token gerado para cada signatário.
Atenção: Certifique-se de estar utilizando o signer_token (token do signatário) e não o document_token (token do documento). Em caso de dúvidas, consulte Tipos de tokens e como localizá-los.
Este endpoint é assíncrono, isto é, você irá pedir a assinatura dos documentos e receberá uma resposta quase imediata da ZapSign. Conforme os documentos forem ficando prontos, você irá receber os webhooks em sua aplicação um por vez. Recomendamos o envio de 100 documentos por vez.
Somente usuários cadastrados em sua conta podem assinar via API. Não é possível assinar em nome de terceiros ou clientes externos.
Assinar via API não consome créditos, mas é necessário possuir um Plano de API ativo, inclusive para documentos em sandbox/teste.
Atualmente, o método de assinatura em lote está disponível apenas para documentos que utilizam "assinatura na tela" como método de autenticação. Estamos trabalhando para estender essa funcionalidade para outros métodos de autenticação.
