Chaves de API
Atualizado em
Onde: Definições > Integrações > Chaves de API
Para que serve:
"Dê a um programa externo sua própria chave para enviar pelo SyBox — o token do WhatsApp nunca sai do servidor, e uma chave vazada é revogada por conta própria." Seu ERP, ponto de venda ou programa de desktop usa uma chave do SyBox. Ele nunca precisa das suas credenciais reais do WhatsApp.
O que um programa pode fazer com uma chave (descrito na página pública de Documentação do Desenvolvedor):
- Enviar mensagens do WhatsApp a partir do seu próprio número conectado. Ele usa o mesmo formato de solicitação da WhatsApp Cloud API da Meta, portanto, um programa já criado para isso precisa apenas de um novo endereço e de uma chave do SyBox. Mensagens de texto, modelos, imagens, documentos e mensagens interativas funcionam perfeitamente. Respostas e erros retornam exatamente como a Meta os envia.
- Registar uma reclamação a partir do seu próprio sistema, por exemplo, uma reclamação registrada no seu ERP. O cliente já deve existir no SyBox.
- Importar SMS de um telefone para a caixa de entrada.
Quem pode abrir: o administrador principal e membros da equipe com a permissão "Gerenciar números do WhatsApp".
A chave de alternância "Gateway de API":
Na parte superior da tela de chaves de API, há uma opção chamada "Gateway de API". Ela fica desativada por padrão. Enquanto estiver desativada, nenhuma chave funcionará e você não poderá criar novas chaves. Se tentar, você verá "O gateway de API está desativado. Ative-o com a opção na parte superior desta tela antes de criar chaves." A opção salva no momento em que você clica nela.
- Vá para Definições > Integrações > Chaves de API.
- Ative a opção "Gateway de API".
- Clique em "Nova chave".
- Escolha o "Tipo de chave":
- "Enviar pelo WhatsApp": o programa envia mensagens para seus clientes.
- "Registar uma reclamação": o programa abre casos no SyBox. Ele não pode enviar mensagens.
- "Importar SMS de um telefone": um telefone encaminha suas mensagens SMS para a caixa de entrada.
- Preencha "Nome do dispositivo ou programa", por exemplo, "Computador do escritório" ou "Sistema de contabilidade". Dê a cada dispositivo ou programa sua própria chave.
- Para uma chave do tipo "Enviar pelo WhatsApp", defina também:
- "Envia de": o número do WhatsApp de onde esta chave envia (obrigatório).
- "Permitir mensagens de texto livre": ativado ou desativado.
- "Permitir modelos aprovados": ativado ou desativado. Pelo menos um destes dois deve estar ativado, caso contrário você verá "Permita pelo menos texto livre ou modelos — caso contrário, a chave não poderá enviar nada."
- "Permitir envio de mídia": ativado ou desativado.
- "Modelos" (opcional): nomes dos modelos, separados por vírgulas. Deixe em branco para permitir qualquer modelo.
- "Países de destinatários permitidos" (opcional): códigos de país de duas letras, por exemplo, MA,FR,EG. Deixe em branco para permitir qualquer país.
- "Envio permitido das" ... "Para": os horários em que a chave pode enviar. Deixe ambos iguais para não ter limite de horário. Os horários seguem o fuso local do espaço de trabalho.
- "Limite diário de mensagens (0 = ilimitado)".
- Para uma chave do tipo "Importar SMS de um telefone", defina "Apenas contatos e clientes". Quando estiver ativado, um SMS de qualquer outro número permanece no telefone e nunca chega à caixa de entrada. Desative isso apenas se o telefone for usado exclusivamente para o trabalho.
- Clique em Salvar.
- Uma janela mostra a "URL base" e a "Chave de API". Copie-as agora. "Copie esta chave agora — ela é exibida apenas uma vez." Cole-as nas configurações do seu programa.
O que o cartão da chave mostra:
- O nome da chave e o número de onde ela envia (ou o selo do tipo dela, para uma chave que não envia).
- Os últimos caracteres da chave, para que você possa diferenciá-las.
- "usado pela última vez", com data e hora, ou "nunca".
- Quaisquer limites que estejam ativados: "Somente texto livre", "Somente modelos", "sem mídia", "Modelos", países permitidos, horários de envio e o limite diário exibido como enviado hoje / limite / dia. Uma chave de SMS que aceita qualquer número mostra "Todos os números".
- Clique em Editar no cartão da chave. Você pode alterar seu nome, número e limites. O tipo de chave não pode ser alterado após a criação, e a chave em si nunca mais é exibida.
- Clique em Ativar / Desativar para pausar uma chave temporariamente.
- Clique em Excluir e confirme: "Excluir esta chave de API? Qualquer programa que ainda a use para de funcionar imediatamente."
Perdi minha chave de API. Posso vê-la novamente?
Não. Ela é exibida apenas uma vez. Crie uma nova chave, insira-a em seu programa e exclua a chave antiga.
Acho que uma chave vazou. O que eu faço?
Exclua essa chave, ou desative-a, imediatamente. Apenas essa chave deixará de funcionar. Seu número do WhatsApp e suas outras chaves não serão afetados.
A lista "Envia de" está vazia.
A lista mostra apenas números do WhatsApp que estão conectados e ativados. Conecte um número primeiro, em Definições > Mensagens > Canais.
Meu programa é recusado ao enviar.
Verifique se a opção "Gateway de API" está ativada e se a chave está ativa. Verifique também os limites da chave: texto livre versus modelos, mídia, modelos permitidos, países permitidos, horários de envio e o limite diário. As próprias regras do WhatsApp também continuam valendo. Por exemplo, texto livre só funciona dentro de 24 horas da última mensagem do cliente.
Uma chave do tipo "Registar uma reclamação" também pode enviar mensagens?
Não, de propósito. Uma chave que abre chamados não pode enviar mensagens para clientes, e uma chave de envio não pode abrir chamados. Use uma chave separada para cada função.
Tenho uma chave antiga do tipo "Receber de um programa". Ela ainda funciona?
Sim, chaves existentes desse tipo continuam funcionando. Novas chaves desse tipo não podem mais ser criadas. Use "Registar uma reclamação" para esse tipo de tarefa.