Api: onde criar, copiar e revogar a chave de acesso e onde está a documentação

Para um sistema seu (ou uma automação) criar documentos e acompanhar assinaturas sem ninguém abrir a tela, ele precisa de uma chave de API. Aqui está onde criar, copiar e revogar essa chave e onde fica a documentação. O que dá para fazer pela API está em outro artigo.

Caminho

  • Configurações › Api

A tela Integração API Assinatura Digital tem dois cartões, cada um com o botão Abrir:

  • Documentação — "Endpoints de documentos, signatários, pastas e modelos, com exemplos." Abre a tela Documentação, com a busca Buscar recurso ou endpoint…, a lista de recursos (Usuários, Contatos, Documentos, Modelos e Pastas), as regras de autenticação e de limite de requisições, e o botão Baixar OpenAPI.
  • Credenciais — "Crie, nomeie e revogue as chaves de acesso à API." É onde ficam as chaves.

Se o seu plano não inclui a integração por API, abrir Credenciais leva você para Configurações › Meu plano. A Documentação abre em qualquer plano.

Criar uma chave

Só o usuário master cria chaves, e o plano precisa incluir a integração por API.

1. No cartão Credenciais, clique em Abrir e depois em Nova chave.
2. Dê um Nome à chave, que ajude a lembrar para que ela serve (por exemplo, "Integração com o meu sistema").
3. Escolha a Validade: Nunca expira, 30 dias, 60 dias, 90 dias, 6 meses ou 1 ano. A validade é definida agora e não muda depois.
4. Clique em Criar chave.
5. Na janela Chave criada, copie o Access Token e o Secret Access Token pelos botões de copiar, ou clique em Baixar credenciais para salvar um arquivo com os dois. Depois, Concluído.

Copie o Secret Access Token na hora. Por segurança ele é exibido apenas uma vez: ao fechar a janela, não será mostrado de novo. Se perder, crie outra chave e revogue a antiga.

A lista de chaves

A lista mostra Nome, Access Token, Criada por, Criada em, Último uso ("Nunca usada" se ainda não foi usada) e Expira em ("Nunca", ou a data, com "(expirada)" quando venceu). Quem não é master vê o Access Token parcialmente escondido.

Revogar uma chave

Na linha da chave, clique em Revogar e confirme. A chave deixa de funcionar imediatamente e não pode ser recuperada. Só o usuário master revoga.

Quando dá errado

  • "Somente o usuário master pode criar chaves de API!" (ou "... revogar chaves de API!") — peça ao usuário master da conta.
  • "O seu plano atual não lhe permite integrar com a API. Por favor, contrate outro plano!" — o plano não inclui a integração por API. O sistema leva para Configurações › Meu plano.
  • "Informe um nome para a chave." — o Nome é obrigatório.