Autenticação

Como se autenticar na API da ZapSign.

Para se autenticar em cada endpoint, é muito simples.

Basta inserir o seu Token de Acesso na URL de cada endpoint, sob o parâmetro api_token.

Endpoint: https://api.zapsign.com.br/api/v1/docs/

Endpoint autenticado: https://api.zapsign.com.br/api/v1/docs/?api_token={{seu_token_de_acesso}}

Exemplo final (com Token de Acesso fictício): https://api.zapsign.com.br/api/v1/docs/?api_token=c7f35c84-7893-4087-b4fb-d1f06c23

Atenção

1- Caso você tente acessar algum endpoint sem inserir ?api_token={{seu_token_de_acesso}} ao final, ou então insira um Token inválido, você receberá uma resposta com status 403 (Não Autorizado).

2- Repare que todos os endpoints da nossa API possuem barra ao final. Assim, o ponto de interrogação (?) deve seguir após a última barra (/):

Certo: https://api.zapsign.com.br/api/v1/docs/?api_token={{seu_token_de_acesso}}

Errado: https://api.zapsign.com.br/api/v1/docs?api_token={{seu_token_de_acesso}}

Dicas Extras

  1. Não trabalhamos com null! Quando algum campo é definido como string em nossa API, você não pode defini-lo como null. Assim, caso queira que o campo seja vazio, não o envie em sua requisição, ou o envie como string vazia (se fizer sentido, é claro).

  2. true e false não é o mesmo que "true" e "false". Isso irá te poupar alguns testes frustrados...