Tema
Chaves de API
Uma chave de API permite que outro sistema, como o seu ERP, converse com o Konversia diretamente, sem passar pela tela.
Só o dono
Funcionário não enxerga esta área.
A chave é da empresa, não da pessoa
Quem cria a chave é o dono, mas ela pertence à empresa. Se o funcionário que a gerou sair da equipe, a chave continua funcionando normalmente.
Criar uma chave
Dê um nome que identifique a integração, como "ERP financeiro", e escolha as permissões que ela vai usar.
A chave aparece uma única vez
Ao criar, o valor completo é mostrado uma vez só. Copie e guarde num lugar seguro antes de sair da tela. Não existe como recuperá-la depois: se perder, revogue essa chave e crie outra.
Permissões
Cada chave só faz o que você autorizar:
- Listar canais: consultar as linhas de WhatsApp conectadas na empresa.
- Listar templates: consultar os modelos de mensagem aprovados.
- Consultar mensagens: ler o histórico de conversas pela API.
- Enviar mensagens: disparar mensagens em nome da empresa pela API.
Dê à chave só as permissões que a integração realmente precisa. Uma chave de leitura de canais não deveria também poder enviar mensagem.
Revogar
Revogar uma chave é imediato: qualquer sistema que esteja usando aquele valor para de funcionar na hora, e a ação não pode ser desfeita. Use quando trocar de integração ou desconfiar que a chave vazou.
Assinatura em dia é obrigatória
Com o pagamento pendente, a API para de responder às chamadas dessa chave. Assim que o pagamento é reconhecido, ela volta a funcionar sozinha, sem precisar recriar nada. A chave nunca é apagada por causa de atraso.
Limite de chamadas
Existe um limite de chamadas por minuto para cada chave. Ao esbarrar nele, a integração recebe um aviso de limite excedido: espere um pouco e repita a chamada.
O que a chave já pode fazer
A chave já consulta canais e templates, envia mensagens de texto, mídia e template, e consulta o status de cada envio. Cada uma dessas ações só funciona se a permissão correspondente tiver sido marcada na criação da chave.
Uma mensagem enviada pela integração conta para o limite mensal de envios da empresa, do mesmo jeito que uma mensagem enviada pela tela. E, no canal oficial, uma conversa parada há mais de 24 horas só pode ser reaberta por um template aprovado, mesmo vindo da integração.
Para o passo a passo de como montar a integração, com exemplos de requisição e resposta, veja a documentação para desenvolvedores.
Onde acompanhar o uso
A própria aba mostra:
- um gráfico com as chamadas e os erros dos últimos 30 dias;
- a lista das chamadas mais recentes, com rota, status e duração, para ajudar a depurar a integração.