Primeiros passos
Este tutorial descreve como configurar o cliente da API Local, registrar um número de telefone comercial, atualizar as configurações e enviar uma mensagem de teste.
O processo para começar a usar a API pode ser dividido em 3 partes:
- Preparar os ativos: antes de começar, configure os ativos necessários para realizar a integração da API, incluindo uma conta do WhatsApp Business.
- Instalar o cliente da WhatsApp Business API: instale o cliente da API. Quando o cliente estiver funcionando, você poderá atualizar as configurações do app.
- Começar a usar o cliente: cadastre seu número de telefone com uma chamada de API para
/accounte envie uma mensagem de teste com uma chamada para/messages.
Antes de começar
Você precisará fazer o seguinte:
- Uma conta do Gerenciador de Negócios do Facebook
- Uma linha de crédito para a sua conta do WhatsApp Business. Consulte o artigo Sobre a cobrança da sua conta do WhatsApp Business para mais informações.
- Uma ferramenta de linha de comando como o Terminal ou um app como o Postman que possa fazer solicitações de cURL.
Após a verificação da empresa, é feita uma análise para confirmar se ela segue os Termos de Serviço e a Política Comercial do WhatsApp. Essa etapa é iniciada automaticamente. Você pode ver o status da verificação e da avaliação da empresa na guia Configurações da sua conta do WhatsApp Business no Gerenciador de Negócios. Depois das aprovações, a verificação da empresa será exibida como Verificada e o Status da conta será exibido como Aprovada.
Como configurar sua conta do WhatsApp Business
Adicione um número de telefone e o nome de exibição dele à sua conta do WhatsApp Business. Isso enviará o nome de exibição para avaliação.
É possível alterar o nome de exibição quantas vezes você quiser antes da conclusão do registro. Depois disso, você terá de esperar 30 dias entre cada solicitação de alteração do nome de exibição.
Quando as análises tiverem sido concluídas, você poderá ver e acessar o certificado codificado em Base64, necessário para o registro do cliente da API Local. Incentivamos você a fazer o registro com um nome de exibição aprovado para iniciar a integração antes de fazer outras alterações ao nome de exibição. Você pode mudar o nome de exibição a qualquer momento depois da integração.
Analisar informações sobre cobrança e preço
Assim que a empresa começar a enviar mensagens pela API Local, será importante entender o processo de cobrança. Por exemplo, de que maneira e quando você será cobrado, e como deverá visualizar e pagar a fatura mensal. Para ver mais informações, consulte Sobre a cobrança da sua conta do WhatsApp Business. Para ver as regras de precificação e os custos por mensagem, consulte a página Preços baseados em conversa.
Versões recomendadas do software
| Software | Versão | Detalhes |
|---|---|---|
API Local | ||
API Local para AWS | Verifique o registro de alterações. Versão do modelo: | |
MySQL |
| Não é possível fazer o downgrade da base de dados do MySQL 8 para o MySQL 5. Por isso, faça backup dos dados antes de concluir a migração. |
PostgreSQL |
|
|
Docker | Versão | A versão Verifique se a chamada de sistema statx está em chamadas de sistema permitidas para o docker. |
Postman | Qualquer versão recente. | |
libseccomp |
| Somente a versão |
glibc |
| Somente a versão |
Sistema operacional (SO) | A versão mais recente. | Use pelo menos a versão mínima de kernel |
Etapa 1: instale o cliente da API Local
Ambiente
Em essência, o cliente da API Local é baseado no Docker. Consulte a arquitetura do cliente para ver mais informações sobre cada componente.
No momento, o cliente da API Local não é compatível com o Docker para Windows nem com o subsistema do Windows para Linux. Em caso de necessidades relacionadas a desenvolvimento, a solução recomendada é usar uma máquina virtual Linux para executar o Docker. No caso de cargas de trabalho de produção, recomendamos usar um servidor Linux para evitar problemas de compatibilidade e desempenho.
Equipamento
O cliente da API Local pode ser executado em qualquer computador conectado à internet que execute o Docker para Linux, seja em uma máquina virtual ou em um servidor Linux. Para saber mais, consulte as perguntas frequentes. Por exemplo, testes simples podem ser feitos em um notebook. Para um servidor de ambiente de produção, recomendamos no mínimo SSD de 250 GB, 16 GB de RAM e CPU com 4 núcleos. HDD não é recomendado, pois as velocidades de entrada e saída se tornarão gargalos com a carga.
Na maioria dos casos, é necessário executar o banco de dados em um servidor físico separado dos contêineres do Coreapp e do Webapp. O servidor do banco de dados deve estar a apenas alguns milissegundos de latência do computador.
Instalação
Existem duas maneiras de começar a usar a API Local:
- Instalação no local: configure os contêineres do Docker usando nosso guia de instalação. Recomendamos começar por uma das configurações de desenvolvedor para se familiarizar com o processo de configuração e o envio de mensagens. A solução local pode ser usada no seu computador antes de migrar para um ambiente de produção.
- Amazon Web Services (AWS): se você usar a AWS ou se quiser uma solução mais independente, consulte nosso guia da AWS. Com a AWS, você tem uma solução completa de API Local com backups, recuperação e mais em uma nuvem AWS que você gerencia.
Quando seu cliente da API Local estiver em execução, faça login como admin para realizar as demais etapas de configuração.
Atualizar suas configurações
Você pode alterar as configurações do app depois que o cliente da API Local estiver em execução. No entanto, você não receberá acesso às diferentes configurações de perfil do seu cliente da API Local até que o registro seja concluído.
- As configurações do app tratam do funcionamento do cliente: configurações de retorno de chamada, Webhooks, pagers de chamada, status de envio, comportamento do download de mídias, entre outras. Observação: recomendamos que você configure uma URL do Webhook para receber notificações sobre mensagens recebidas ou erros.
- As configurações do perfil comercial e as configurações de perfil abrangem informações da sua empresa, como endereço, email, site, setor e foto de perfil.
Etapa 2: comece a usar o cliente
Registro
Quando o cliente da API Local estiver funcionando, registre seu número de telefone enviando uma chamada de API ao ponto de extremidade account.
Enviar uma mensagem de teste
Você pode enviar mensagens de teste usando o ponto de extremidade messages. Em primeiro lugar, verifique o status do número de telefone que está sendo usado no teste. Você também precisará enviar uma mensagem para sua conta do WhatsApp com o número de telefone usado no teste. Dessa forma, a janela de atendimento ao cliente será habilitada. Ela permite que você envie qualquer tipo de mensagem em uma janela de 24 horas (consulte Controle de corte para ver detalhes). Depois, envie um SMS para o número de telefone de teste. Se a mensagem chegar, significará que a instalação foi bem-sucedida. Caso contrário, verifique o Webhook em busca de notificações que possam indicar algum problema.
Segurança
Consulte nosso guia de segurança para ver informações sobre a relação do cliente da API Local e elementos como senhas, autenticação, configuração SSL, segregação de rede, comunicações criptografadas, cabeçalhos HTTP e protocolo TLS do servidor da web.
Processo de inicialização
A API Local do WhatsApp passa por um procedimento de inicialização ao estabelecer uma conexão com o servidor. Esse processo é essencial para garantir um meio contínuo e confiável de enviar e receber mensagens. Durante a fase de inicialização, o aplicativo principal (coreapp) aguarda o cumprimento de vários pré-requisitos, incluindo os listados a seguir:
Carregar mensagens de modelo: a API carrega mensagens de modelo do servidor como parte do processo de inicialização.
Receber e processar mensagens offline: ela também gerencia a recepção e o processamento de mensagens offline.
Caso ocorram tentativas de envio de mensagens antes de os pré-requisitos serem atendidos, o aplicativo principal responderá com uma mensagem de erro "O coreapp não está pronto", e os registros exibirão um erro "O serviço não está pronto". É importante ressaltar que esse processo de inicialização é executado sempre que uma nova conexão é estabelecida com o servidor do WhatsApp. Consequentemente, se o aplicativo principal for reiniciado ou desconectado, o processo de inicialização será iniciado outra vez para definir o estado do coreapp como "pronto". Isso garante a confiabilidade e a prontidão da API Local do WhatsApp para comunicação por meio de mensagens.
Processamento de mensagens offline
A etapa de processamento de mensagens offline será omitida quando não houver mensagens desse tipo a serem encontradas. Em outras palavras, se não houver mensagens aguardando em estado offline, essa fase específica do processo será ignorada.
Em condições normais, a API Local do WhatsApp segue um protocolo padrão para lidar com mensagens offline. Ela aguarda a recepção e o processamento de todas as mensagens offline, com um tempo-limite máximo predefinido de 6 minutos. Após esse período, a fase de processamento de mensagens offline será considerada concluída com sucesso.
Sugestões adicionais
O QUE FAZERTeste o envio e recebimento de mensagens com funcionários internos primeiro para verificar se o sistema está funcionando. Responda a todos os clientes em até 24 horas. Use vários números de telefone para desenvolvimento, teste e produção. Confira as perguntas frequentes antes de criar um tíquete junto ao Suporte Direto. Forneça feedback sobre o produto. O Suporte Direto é o melhor canal para isso. | O QUE NÃO FAZERNão envie notificações duplicadas por vários canais. Não envie spam. Não use números 0800 nos testes. Não crie um Gerenciador de Negócios apenas para integrações do WhatsApp. Use um existente, se disponível. |
Se detectarmos que você violou alguma das nossas orientações ou políticas, nós nos reservamos o direito de limitar ou remover seu acesso ao WhatsApp.