Configuración para desarrolladores: instancia única

En este documento se describe cómo configurar una instancia única del cliente de la API de WhatsApp Business en una máquina de desarrollador con el propósito de realizar pruebas. Para una configuración de producción, sigue las instrucciones pertinentes que se detallan en Configuraciones de producción.

Para configurar una instancia única desde el principio, consulta la lista de requisitos y sigue los pasos siguientes:

1. Crea un directorio biz para los scripts de configuración.
2. Obtén los archivos de configuración del cliente de la API de WhatsApp Business.
3. Configura la variable de entorno WA_API_VERSION.
4. Inicia el cliente de la API de WhatsApp Business.
5. Verifica que los contenedores se están ejecutando.
6. Realiza una comprobación de estado.
7. Registra el cliente de la API de WhatsApp Business.

Una vez que hayas configurado la instancia por completo, puedes elegir actualizarla. Para desinstalar el cliente, sigue estos pasos.

Antes de empezar

Antes de empezar, necesitarás hacer lo siguiente:

Otros requisitos previos

Asegúrate de configurar una cuenta de prueba local en un entorno de desarrollo. Esto ayudará a desarrollar más rápido y a probar los nuevos lanzamientos.

Configuración inicial del cliente de la API de 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"
    }
}

Actualizar el cliente de la API de WhatsApp Business

Paso 1: Cambiar la variable de entorno WA_API_VERSION por la nueva versión

La variable de entorno WA_API_VERSION debe actualizarse al nuevo número de versión mediante lo siguiente:

export WA_API_VERSION=new-whatsapp-version

Si vas a actualizar a la versión 2.33.4, el comando de ejemplo sería el siguiente:

~/biz $ export WA_API_VERSION=2.33.4

Paso 2: Reiniciar los contenedores de Docker

Reinicia los contenedores de Docker ejecutando lo siguiente:

docker-compose up -d

La salida resultante debería tener el siguiente aspecto:

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

Para los usuarios de la base de datos MySQL que actualizan a la versión v2.23.x y posteriores

Ahora se puede hacer uso del servicio de actualización de la base de datos, que permite actualizar la base de datos mientras la aplicación se ejecuta para evitar tiempos de inactividad.

Paso 1: Descargar el archivo de configuración

El archivo dbupgrade-compose.yml contiene campos que indican la versión del contenedor.

Ejemplo:

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

Paso 2: Iniciar el contenedor

Para actualizar una instalación, inicia el contenedor de servicio “dbupgrade” con la variable de entorno WA_API_VERSION establecida en la versión más reciente:

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

Nota: Si vas a utilizar una orquestación que reinicia el contenedor al salir independientemente del código de salida, inicia el servicio con la variable de entorno EXIT_ON_SUCCESS establecida en FALSE para evitar salir del contenedor cuando el código de salida sea 0.

Paso 3: Permitir que finalice la actualización

Si la actualización de la base de datos se realiza correctamente, el contenedor saldrá con el código 0. Puedes utilizar el siguiente comando Docker para hacer un seguimiento del estado:

docker wait your-database-upgrade-container-name

Esta operación mostrará el código de salida del contenedor de servicio “dbupgrade”.

Paso 4: Reiniciar los contenedores de la aplicación principal y la aplicación web

Reinicia los contenedores de la aplicación principal y la aplicación web con la variable de entorno WA_API_VERSION establecida en la versión más reciente:

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

Desinstalar el cliente de la API de WhatsApp Business

Si necesitas restablecer tu entorno de desarrollo mediante la eliminación de todos los contenedores, ejecuta el siguiente comando desde el directorio que contiene el archivo docker-compose.yml:

WA_API_VERSION={VERSION_NUMBER} docker-compose down

La salida resultante debería tener el siguiente aspecto:

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 deshacerte de todos los volúmenes que se definen en el archivo docker-compose.yml, además de los contenedores, ejecuta el comando down con el parámetro -v:

WA_API_VERSION={VERSION_NUMBER} docker-compose down -v

Solución de problemas

En los casos en los que WADebug no se pueda usar o su uso devuelva errores, ejecuta el siguiente comando para obtener los registros de todos los contenedores:

docker-compose logs > debug_output.txt

Para obtener los registros de un servicio determinado, añade el nombre del servicio (waweb o wacore) al comando docker-compose logs:

docker-compose logs waweb > debug_output.txt

Encontrarás los registros en el archivo debug_output.txt del directorio actual.

Más información

• Configuración para desarrolladores: alta disponibilidad y conexión múltiple
• Instalación
• Configuraciones de producción