Referência interativa e console de testes

A referência interativa da API reúne, numa página só, todos os endpoints, objetos, erros e webhooks do ODSign, com exemplos prontos em cURL, PHP, Node.js e Python e um console para fazer as chamadas pelo próprio navegador, com o seu token. É o jeito mais rápido de entender as respostas antes de escrever código.

O que há na página

Os exemplos de código mudam de linguagem para a página inteira: escolha PHP, por exemplo, uma vez.

Passo a passo: testar uma chamada

1. Crie um token em Configurações › Conta › Tokens da API (veja Criar e usar um token de API).
2. Na referência interativa, cole o token em Token da API e clique em Conferir o token.
3. Vá até o endpoint desejado, por exemplo Listar envelopes, e clique em Testar esta chamada.
4. Preencha os campos (os opcionais podem ficar vazios) e clique em Enviar requisição.
5. Veja abaixo o código HTTP, o tempo, os cabeçalhos de limite de uso e o corpo da resposta. Nos downloads, aparece o link Baixar com o arquivo recebido.
6. Use Copiar como cURL para levar a mesma chamada para o terminal ou para o seu código.

Criar um envelope pelo console

Em Criar envelope (e enviar), o formulário vem com os campos do exemplo (assunto, mensagem e o primeiro destinatário) e send em 0, para criar um rascunho. Escolha o PDF em files[], informe o seu e-mail em recipients[0][email] e envie. Use Adicionar campo para incluir outros, como recipients[1][name], recipients[0][phone] ou signing_order.

Para enviar de verdade, troque send para 1 e marque a confirmação Com send=1, entendo que os convites saem de verdade.: o console não envia sem ela. O mesmo vale para Enviar rascunho, Reenviar o convite e Anular envelope.

Atenção: Não há ambiente de testes separado. O console age na conta real do token: envios avisam pessoas de verdade e contam nas cotas do plano. Rascunhos não saem para ninguém e não contam no limite mensal; você pode excluí-los depois em Envelopes › Rascunhos.

Segurança do token no console

• O token vai só para a API (app.odsign.com.br), no cabeçalho Authorization, direto do seu navegador. A página da central de ajuda não recebe nem guarda o token.
• Por padrão, o token fica apenas na memória da página e some ao recarregar. Com Lembrar nesta aba do navegador, ele fica guardado só nesta aba e some ao fechá-la. Apagar limpa o campo e a lembrança.
• Use um token criado para testes e um computador seu. Se o token for exposto, peça a revogação ao suporte (veja Se o token vazar).

Importar no Postman ou no Insomnia

O contrato completo da API está em OpenAPI 3.1, nos endereços docs.odsign.com.br/api/openapi.json e docs.odsign.com.br/api/openapi.yaml. Ele é gerado a partir do próprio código da API, então nunca fica desatualizado.

Postman

1. Clique em Import e escolha Link.
2. Cole https://docs.odsign.com.br/api/openapi.json e confirme.
3. Na coleção criada, abra Authorization, escolha Bearer Token e cole o token.

Insomnia

1. Clique em Create e escolha Import.
2. Escolha URL, cole https://docs.odsign.com.br/api/openapi.yaml e confirme.
3. Em cada requisição (ou no ambiente), escolha Bearer Token e cole o token.

Dica: Geradores de cliente, como o OpenAPI Generator, aceitam o mesmo arquivo para criar um SDK na linguagem do seu sistema.

Problemas comuns

• "Informe o token da API..." ao testar. O campo Token da API, no começo da página, está vazio. Cole o token e tente de novo.
• "A requisição não chegou à API". Uma extensão do navegador (bloqueador de anúncios, antivírus) pode estar bloqueando a chamada. Tente numa janela sem extensões ou use Copiar como cURL.
• 401 mesmo com o token colado. Confira se o token está completo (começa com ods_) e se o usuário dono dele não foi bloqueado.
• O arquivo não sobe. Cada arquivo pode ter até 25 MB e precisa ser PDF, JPG, PNG, DOC ou DOCX.