Assinar em lote via API

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:

• Como utilizar o Postman para assinar em lote;

• Como conseguir o user_token;

• Como conseguir o signers_token;

---

Como utilizar o Postman para assinar em lote

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.

Usuário assinando um documento via endpoint de assinatura em lote.

Exemplo de requisição

Sign in batch | ZapSign WorkspacePostman

POST https://api.zapsign.com.br/api/v1/sign

Headers

Name	Type	Description
Authorization*	string	Api token a frente do texto "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

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).

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.

Exemplos de respostas

200- Sucesso

{"message":"Documento(s) assinado(s) com sucesso. Lembrete: este endpoint é assíncrono, então aguarde os PDF finais ficarem prontos via webhooks ou confira-os daqui alguns minutos."}

404- "detail": "Não encontrado."

Caso você tente realizar uma requisição com user_token ou signer_tokens que não existam, você receberá uma response 404 (não encontrado).

---

Como conseguir o user_token?

Para realizar a assinatura via API, é necessário o user_token do usuário que irá assinar os documentos. Siga os passos abaixo:

1. Faça login no usuário que irá assinar os documentos.

2. Entre em Configurações>meu perfil

3. No final da página, habilite a assinatura via API.

4. Copie o token gerado e cole no parametro user_token, dentro da request.

   

   Como conseguir seu user token

---

Como Conseguir o signer_token?

Cada signatário (signer) criado na ZapSign possui um token individual. Para obter o token do signatário, siga os passos:

1. Crie ou acesse um documento.

2. Adicione o signatário ao documento.

3. 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.

Assinatura em API

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.