Assinar em lote via API

post
Assinar em lote via API
https://api.zapsign.com.br/api/v1/sign/?api_token={{seu_token_de_acesso}}
Caso alguém da sua empresa tenha sempre que assinar muitos documentos na ZapSign, uma opção é realizar essa assinatura programaticamente via API. 

Pré-requisitos: 
1. você só pode assinar via API com usuários da sua conta, adicionados nas Configurações. Ou seja, não é possível assinar programaticamente para terceiros ou clientes externos que não sejam usuários na sua conta; 
2. assinar via API não consome créditos (é gratuito), mas é necessário possuir um Plano de API ativo para conseguir utilizar este endpoint, inclusive com documentos sandbox/testes.
Request
Response
Request
Body Parameters
user_token
required
string
Token do usuário que irá assinar.
signer_tokens[]
required
array
Tokens que serão assinados (token do signer em cada documento a ser assinado). 
Response
200: OK
​
Exemplo de requisição
{
    "user_token": "23d4d2d5-8998-4516-b2f8-6045c4eabc9d", //token do usuário que irá assinar
    "signer_tokens":[
        "3c8f16f8-949b-432a-adea-d1e544bb91be", //token de signatário do primeiro documento
        "fed91ab3-bb69-46f9-8c2d-9594772b1186" //token de signatário do segundo documento
    ]
}
Exemplo de response (bem sucedida)
{"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."}
Como conseguir o user_token?
Faça login no usuário que irá assinar os documentos e entre em seu perfil:
Perfil do usuário.
No final da página, habilite a assinatura via API e copie o token.
Como conseguir os signer_tokens?
Todo signatário (signer) criado na ZapSign possui um token. Basta copiar esse token gerado pela ZapSign após um documento ser criado ou depois de você adicionar um signatário. (Atenção: não é o token do documento, e sim o token do signatário!)
Obs: se deseja assinar apenas um documento por vez, basta inserir um array com apenas um token do signer. Ex: signer_tokens: ["123-abc-456-def"]
Erros 404
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). Caso isso ocorra, veja com atenção se você está usando de fato o token do signatário em vez do token do documento, e se não está invertendo com o user_token, etc. 
Endpoint Assíncrono
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. 
Evite assinar mais do que 100 documentos de uma vez só para evitar lentidão. Faça mais de uma requisição se o caso.

Signatários - Previous

Excluir signatário

Next - Webhooks

Como funcionam os Webhooks

Last updated 1 month ago

Assinar em lote via API

postAssinar em lote via API

Exemplo de requisição

Exemplo de response (bem sucedida)

Como conseguir o user_token?

Como conseguir os signer_tokens?

Erros 404

Endpoint Assíncrono

post
Assinar em lote via API