Gerar uma Chave de API

O Que É e Quando Usar

A chave de API é a credencial que um sistema de fora usa para ler ou gravar dados no CRM sem passar por uma tela de login. Use uma quando outro sistema da empresa precisa consultar oportunidades, criar contatos ou acompanhar tarefas de forma automática.

A tela fica em Configurações, item API, e se chama Chaves de API. A descrição do topo é "Gere chaves para integrar sistemas externos ao CRM com escopos controlados". Duas abas organizam a lista: Ativas e Revogadas.

Criar a Chave

1. Abra Configurações e vá em API.

2. Clique em Nova chave. Na primeira vez, quando ainda não existe nenhuma,

   o botão aparece como Criar primeira chave.

3. No diálogo Nova chave de API, preencha o Nome. Use algo que

   identifique o sistema que vai consumir a chave, como no exemplo da própria tela, "Integração ERP". O nome é obrigatório.

4. Em Escopos, ligue o que a chave pode fazer. Cada linha é um recurso

   (Contatos, Empresas, Oportunidades, Tarefas, Produtos, Tags, Funis, Etapas e Motivos de perda) com duas chaves: Leitura e Escrita.

5. Clique em Criar chave.

Ligar Escrita em um recurso liga Leitura junto e deixa a leitura travada, porque quem grava também precisa consultar. Desligar a escrita devolve a leitura ao seu controle. É preciso selecionar ao menos um escopo: sem nenhum, o diálogo mostra "Selecione ao menos um escopo".

Conceda só o que a integração realmente usa. Uma chave de leitura em um recurso faz menos estrago se vazar do que uma chave de escrita em todos.

O Que Acontece Depois de Criar

Aparece a confirmação Chave criada e, na sequência, um diálogo com o mesmo título mostrando o segredo. Esse diálogo é o único momento em que o valor aparece. A tela deixa isso explícito em três lugares: "Guarde o valor em local seguro. Ele não poderá ser recuperado", o alerta Atenção com "Copie sua chave agora. Ela não será exibida novamente", e o lembrete de que a chave não aparece de novo.

O diálogo não fecha no clique fora nem no Esc. O botão Já copiei só habilita depois que você copia, por Copiar chave ou pelo botão que copia um exemplo de chamada pronto.

Guarde o valor em um gerenciador de senhas ou no cofre de segredos usado pela equipe de tecnologia. Não envie a chave por mensagem, e-mail, planilha ou comentário de tarefa. Se você perder o valor, não há como recuperá-lo: o caminho é revogar a chave e gerar outra.

Ler a Lista de Chaves

Cada chave ocupa um cartão com o nome, um selo Ativa ou Revogada, a data em Criada em e o Último uso, que aparece como "nunca" enquanto ninguém usou a chave. Abaixo, um selo por escopo, no formato "Contatos: leitura" ou "Oportunidades: escrita".

Acima da lista, o cartão Como chamar a API reúne o que o sistema externo precisa enviar em cada chamada, com um botão para copiar o identificador da sua conta e um link para a Documentação da API.

Revogar uma Chave

1. Na aba Ativas, localize o cartão da chave e clique em Revogar.

2. Leia a confirmação: a chave "será revogada permanentemente. Esta ação não

   pode ser desfeita".

3. Confirme em Revogar chave.

A confirmação é Chave revogada, e o cartão passa para a aba Revogadas. A tela avisa antes que as integrações que usam aquela chave deixam de ser aceitas na hora, então combine a troca com quem mantém o sistema externo. Revogue sempre que alguém que tinha acesso ao valor deixa a equipe.

Limitações e Permissões

O item API só aparece em Configurações para administradores da conta. O escopo da chave é definido apenas na criação: para mudar o que ela pode fazer, revogue e crie outra.

Artigos Relacionados

• Criar um Webhook
• Verificar Saúde da Conexão
• Ajustar Permissões do Cargo