Configuration de développeur·se : instance unique

Ce document explique comment configurer une instance unique du client de l’API WhatsApp Business sur une machine de développeur·se à des fins de test. Pour une configuration en production, suivez les instructions correspondantes de la section Configurations en production.

Pour configurer une instance unique, consultez notre liste de conditions requises, puis suivez ces étapes :

1. Créer un répertoire biz pour les scripts de configuration
2. Obtenir les fichiers de configuration du client de l’API WhatsApp Business
3. Définir la variable d’environnement WA_API_VERSION
4. Démarrer le client de l’API WhatsApp Business
5. Vérifier que les conteneurs s’exécutent
6. Effectuer un contrôle de l’état
7. Inscrire le client de l’API WhatsApp Business

Une fois que votre instance est entièrement configurée, vous pouvez choisir de mettre à jour le client. Pour désinstaller le client, suivez ces étapes.

Avant de commencer

Avant de commencer, vérifiez que vous possédez les éléments suivants :

Autres conditions requises

Configurez un compte de test localement dans un environnement de développement. Il assure un développement rapide et permettra de tester les nouvelles versions.

Configuration initiale du client de l’API 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"
    }
}

Mise à jour du client de l’API WhatsApp Business

Étape 1 : Modifier la variable d’environnement WA_API_VERSION sur la nouvelle version

La variable d’environnement WA_API_VERSION doit toujours être mise à jour de manière à indiquer le numéro de la nouvelle version avec la commande :

export WA_API_VERSION=new-whatsapp-version

Si vous effectuez la mise à jour vers la version 2.33.4, la commande se présentera comme suit :

~/biz $ export WA_API_VERSION=2.33.4

Étape 2 : Redémarrer les conteneurs Docker

Redémarrez les conteneurs Docker en exécutant :

docker-compose up -d

Le résultat de cette commande doit se présenter comme suit :

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

Pour les utilisateur·ices de bases de données MySQL passant à v2.23.x ou une version ultérieure

Vous pouvez maintenant utiliser un service de mise à jour qui vous permettra de mettre à jour votre base de données pendant l’exécution de votre application, pour éviter les temps d’arrêt.

Étape 1 : Télécharger le fichier de configuration

Le fichier dbupgrade-compose.yml contient des champs indiquant la version du conteneur.

Exemple :

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

Étape 2 : Démarrer le conteneur

Pour mettre à jour une installation, démarrez le conteneur dbupgrade-service avec la variable d’environnement WA_API_VERSION définie sur la dernière version :

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

Remarque : si vous utilisez une orchestration qui redémarre le conteneur à la sortie indépendamment du code de sortie, démarrez le service avec la variable d’environnement EXIT_ON_SUCCESS définie sur FALSE pour éviter de quitter le conteneur lorsque le code de sortie est 0.

Étape 3 : Laisser la mise à jour se terminer

Si la mise à jour de la base de données est réussie, le code de sortie du conteneur sera 0. Vous pouvez utiliser la commande Docker suivante pour suivre l’état :

docker wait your-database-upgrade-container-name

Le code de sortie du conteneur dbupgrade-service sera alors indiqué dans la sortie.

Étape 4 : Redémarrer les conteneurs Coreapp et Webapp

Redémarrez les conteneurs Docker Coreapp et Webapp avec la variable d’environnement WA_API_VERSION définie sur la dernière version :

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

Désinstallation du client de l’API WhatsApp Business

Pour réinitialiser votre environnement de développement en supprimant tous les conteneurs, exécutez la commande suivante depuis le répertoire contenant le fichier docker-compose.yml :

WA_API_VERSION={VERSION_NUMBER} docker-compose down

Le résultat de cette commande doit se présenter comme suit :

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

Afin de supprimer également tous les volumes définis dans le fichier docker-compose.yml, exécutez la commande down avec le paramètre -v :

WA_API_VERSION={VERSION_NUMBER} docker-compose down -v

Dépannage

Si vous ne pouvez pas utiliser WADebug ou que son exécution renvoie des erreurs, exécutez la commande suivante pour recueillir les journaux de tous les conteneurs :

docker-compose logs > debug_output.txt

Pour recueillir les journaux d’un service spécifique, ajoutez le nom du service (waweb ou wacore) à la commande docker-compose logs :

docker-compose logs waweb > debug_output.txt

Vous trouverez les journaux dans le fichier debug_output.txt enregistré dans le répertoire actuel.

En savoir plus

• Configuration de développeur·se : haute disponibilité et Multiconnect
• Installation
• Configurations de production