Configuração do desenvolvedor: instância única

Este documento mostra como configurar uma instância única do cliente da API do WhatsApp Business em uma máquina de desenvolvedor para fins de teste. Caso você queira uma configuração de produção, siga as instruções listadas em Configurações de produção.

Para configurar inicialmente uma instância única, confira nossa lista de requisitos e execute estas etapas:

1. Criar um diretório biz para os scripts de configuração
2. Obter os arquivos de configuração do cliente da API do WhatsApp Business
3. Definir a variável de ambiente WA_API_VERSION
4. Iniciar o cliente da API do WhatsApp Business
5. Verificar se os contêineres estão em execução
6. Executar uma verificação de integridade
7. Registrar o cliente da API do WhatsApp Business

Depois de concluir a configuração da sua instância, você pode atualizá-la. Para desinstalar o cliente, siga estas etapas.

Antes de começar

Antes de começar, você precisará realizar o seguinte:

Outros pré-requisitos

Configure uma conta de teste local em um ambiente de desenvolvimento. Ela deve ser usada para agilizar o desenvolvimento e testar lançamentos.

Configuração inicial do cliente da API do WhatsApp Business

~/biz $ export WA_API_VERSION=CURRENT-WA-API-VERSION

    wacore:
    image: docker.whatsapp.biz/coreapp:v${WA_API_VERSION:?Run docker-compose with env var WA_API_VERSION (ex. WA_API_VERSION=2.31.4 docker-compose <command> <options>)}

~/biz $ docker-compose up -d

Creating volume "biz_whatsappMedia" with local driver
Creating volume "biz_mysqlData" with local driver
Creating biz_db_1 ... done
Creating biz_wacore_1 ... done
Creating biz_waweb_1  ... done

~/biz $ docker-compose ps

~/biz $ docker-compose ps
     Name                    Command               State                   Ports
-------------------------------------------------------------------------------------------------
biz_db_1       docker-entrypoint.sh mysqld      Up      0.0.0.0:33060->3306/tcp, 33060/tcp
biz_wacore_1   /opt/whatsapp/bin/wait_on_ ...   Up      6250/tcp, 6251/tcp, 6252/tcp, 6253/tcp
biz_waweb_1    /opt/whatsapp/bin/wait_on_ ...   Up      0.0.0.0:9090->443/tcp

{
    "health": {
        "gateway_status": "unregistered"
    }
}

Atualização do cliente da WhatsApp Business API

Etapa 1: alterar a variável de ambiente WA_API_VERSION para a nova versão

A variável de ambiente WA_API_VERSION precisa ser atualizada para a versão mais recente por meio de:

export WA_API_VERSION=new-whatsapp-version

Se você estiver atualizando para a versão 2.33.4, o comando de exemplo será:

~/biz $ export WA_API_VERSION=2.33.4

Etapa 2: reiniciar os contêineres do Docker

Reinicie os contêineres do Docker executando:

docker-compose up -d

A saída terá aparência semelhante a esta:

biz_db_1 is up-to-date
Recreating biz_wacore_1 ... done
Recreating biz_waweb_1  ... done

Para usuários do banco de dados MySQL que estão atualizando para v2.23.x e versões posteriores

Agora você pode usar um serviço de atualização do banco de dados para atualizar o banco de dados enquanto o app continua em execução, evitando o tempo de inatividade.

Etapa 1: baixar o arquivo de configuração

O arquivo dbupgrade-compose.yml tem campos que indicam a versão do contêiner.

Exemplo:

services:
  dbupgrade:
    image: docker.whatsapp.biz/coreapp:v${WA_API_VERSION:-2.21.3}

Etapa 2: inicializar o contêiner

Para atualizar uma instalação, inicialize o contêiner dbupgrade-service com a variável de ambiente WA_API_VERSION definida como a versão mais recente:

WA_API_VERSION=new-whatsapp-version docker-compose -f dbupgrade-compose.yml up -d

Observação: se você estiver usando uma orquestração que reinicia o contêiner na saída independentemente do código de saída, inicialize o serviço com a variável de ambiente EXIT_ON_SUCCESS definida como FALSE. Isso evitará a saída do contêiner quando o código de saída for 0.

Etapa 3: permitir que a atualização seja concluída

Se a atualização do banco de dados for bem-sucedida, o contêiner sairá com o código 0. É possível usar o seguinte comando do Docker para acompanhar o status:

docker wait your-database-upgrade-container-name

Com isso, o código de saída do contêiner dbupgrade-service será criado.

Etapa 4: reiniciar os contêineres do Coreapp e do Webapp

Reinicie os contêineres do Docker do Coreapp e do Webapp com a variável de ambiente WA_API_VERSION definida como a versão mais recente:

WA_API_VERSION=new-whatsapp-version docker-compose up -d

Desinstalar o cliente da WhatsApp Business API

Se você precisar redefinir seu ambiente de desenvolvimento removendo todos os contêineres, execute o seguinte comando no diretório que contêm o arquivo docker-compose.yml:

WA_API_VERSION={VERSION_NUMBER} docker-compose down

A saída terá aparência semelhante a esta:

Stopping biz_waweb_1  ... done
Stopping biz_wacore_1 ... done
Stopping biz_db_1     ... done
Removing biz_waweb_1  ... done
Removing biz_wacore_1 ... done
Removing biz_db_1     ... done

Para eliminar todos os volumes definidos no arquivo docker-compose.yml além dos contêineres, execute o comando down com o parâmetro -v:

WA_API_VERSION={VERSION_NUMBER} docker-compose down -v

Solução de problemas

Se o WADebug não puder ser usado ou a execução da ferramenta retornar erros, execute o seguinte comando para coletar registros de todos os contêineres:

docker-compose logs > debug_output.txt

Para coletar os registros de um serviço específico, anexe o nome do serviço (waweb ou wacore) ao comando docker-compose logs:

docker-compose logs waweb > debug_output.txt

Os registros podem ser encontrados no arquivo debug_output.txt no diretório atual.

Saiba mais

• Configuração do desenvolvedor: alta disponibilidade e multiconexão
• Instalação
• Configurações de produção