Chaves de API
Este guia é para quem quer conectar outro sistema ao DevZap: um CRM, um site, um chatbot. Se você só usa o painel, não precisa de nada disto.
O que é uma chave de API
Uma senha especial que permite ao seu sistema conversar com o DevZap sem precisar de login e senha
de pessoa. Ela começa com ten_ e é longa.
Com uma chave, o seu sistema pode enviar mensagens, criar instâncias e receber avisos de mensagens novas, tudo programaticamente.
Onde ficam
No menu lateral, em Chaves de API (no celular, dentro do menu Mais). A tela vale para qualquer plano: lista as chaves que existem, mostra quando cada uma foi usada pela última vez, e tem os botões de criar, rotacionar e revogar.
Quantas chaves você pode ter ao mesmo tempo depende do plano, e a própria tela diz quantas ainda cabem.
Criar uma chave
- Abra Chaves de API e clique em Nova chave.
- Dê um nome que diga qual sistema vai usá-la (ex.:
CRM do comercial). É por esse nome que você vai saber o que quebra ao revogar. - Validade é opcional. Vazio = chave sem prazo, o mais comum para integração fixa.
- Escolha o tipo de acesso:
- Acesso completo, para o seu sistema: envia mensagens, lê e configura tudo na conta.
- Só consulta, para um assistente de IA: lê números, grupos, etiquetas, envios e agendamentos, e não envia nem muda nada. Na lista, a chave aparece com o selo Só consulta.
- A chave aparece inteira. Copie agora (veja a seção seguinte).
Há um atalho: na página Instâncias, o botão Conectar sistema de cada instância abre as variáveis prontas daquele número, e permite criar a chave ali mesmo, já dentro do bloco que você vai copiar.
Se você está desenvolvendo um aplicativo que conecta contas de outras pessoas: existe um fluxo de autorização (OAuth) próprio para isso, em que o usuário aprova o acesso sem lhe entregar nenhuma senha. Veja a documentação técnica de OAuth.
A chave aparece uma vez só
No momento em que é criada, a chave é exibida por inteiro, e só nesse momento. Depois disso, o painel mostra apenas os primeiros caracteres, o suficiente para você identificar qual é qual.
Copie e guarde num lugar seguro antes de fechar a tela. Se perder o valor, não há recuperação, mas também não é preciso criar outra do zero: use Rotacionar.
Rotacionar
Rotacionar troca o segredo mantendo o nome: a chave antiga morre na hora e uma nova aparece, uma vez, para você copiar.
É o que usar quando a chave vazou, quando alguém que tinha acesso saiu da equipe, ou quando você simplesmente perdeu o valor e precisa reconfigurar o sistema. O sistema que usava a chave antiga para de funcionar até você atualizar o valor nele, então rotacione quando puder fazer as duas coisas juntas.
Cuidados
Trate como senha. Quem tem a chave pode enviar mensagens pelos seus números.
Não coloque em site ou aplicativo que roda no navegador. Qualquer visitante consegue ler. A chave deve ficar no seu servidor.
Não comite no Git. Use variáveis de ambiente.
Uma chave por sistema. Assim, se precisar revogar o acesso de um deles, os outros continuam funcionando.
Se uma chave vazar
Duas saídas, na mesma tela:
- Rotacionar, se o sistema que a usa continua existindo: você troca o segredo e atualiza lá.
- Revogar, se o acesso não deve mais existir. É instantâneo e não tem volta.
Nos dois casos o efeito é imediato: quem estava usando a chave antiga para de funcionar na hora.
Próximo passo
Para conectar um assistente de IA, como o Claude, veja Assistente de IA.
Com a chave em mãos, quem vai programar a integração deve seguir a documentação de integração. Há também uma referência interativa da API em /docs, acessível com o login do painel.