Migration
Si vous avez déjà configuré le client de l’API WhatsApp Business avec une base de données et que vous souhaitez migrer le client et la base de données vers une nouvelle configuration en utilisant le même numéro de téléphone, ce document vous expliquera comment identifier les modifications à apporter et la procédure à suivre.
Avant de commencer
- La sauvegarde est l’étape la plus importante de la migration.
- Vous n’avez pas besoin de réenregistrer votre numéro de téléphone après la migration. Vous pouvez utiliser la messagerie dès que la migration est terminée.
- La nouvelle configuration doit avoir le même nombre de partitions que l'ancienne. Vous ne pouvez pas effectuer de mise à l'échelle lors de la migration. Si votre ancienne configuration est configurée avec un nombre X de Maître et un nombre Y de Coreapp, la nouvelle configuration doit avoir exactement le même nombre de Maître et de Coreapp. Si les nombres de Maître et de Coreapp avant et après la migration ne correspondent pas, la migration échouera.
- Essayez de migrer un compte de test avant de migrer un compte en production.
- Il y aura un temps d'arrêt. La durée dépend de l'option de migration mais chaque migration comprend un temps d'arrêt.
Options de migration
Il existe plusieurs options de migration en fonction de la quantité de données que vous souhaitez migrer. Veuillez choisir l’option qui répond le mieux à vos besoins.
Données conservées pour chaque option de migration
| Option 1 | Option 2 | Option 3 | |
|---|---|---|---|
Paramètres | |||
Paramètres de l’app | ✔ | ✔ | ✔ |
Inscription | ✔ | ✔ | ✔ |
Clés de chiffrement | ✔ | ✔ | ✔ |
Messages | |||
Messages | ✔ | ✔ | |
Rappels | ✔ | ✔ | |
Contacts | ✔ | ✔ | |
Tokens d'authentification | |||
API données de l’utilisateur | ✔ | ||
API tokens d'authentification | ✔ |
Cas d'utilisation courant et temps d'arrêt de chaque option de migration
Ce tableau décrit les cas d’utilisation courants de chaque option de migration et les temps d’arrêt associés. Il s’agit uniquement des cas d’utilisation courants, vous pouvez choisir le type d’option de migration en fonction de vos besoins.
| Cas d’utilisation général | Temps d'arrêt | |
|---|---|---|
Option 1 | Un fournisseur de services transfère un client final vers votre plate-forme et vous souhaitez ne conserver que les paramètres. | Cette option a le temps d'arrêt le plus court par rapport aux autres options car la quantité de données devant être transférées entre les machines est minimale. |
Option 2 | Un fournisseur de services transfère un client final vers votre plate-forme et vous souhaitez conserver les paramètres et les messages. | Cette option a un temps d’arrêt plus long que l’Option 1 car les messages et les paramètres doivent être transférés entre les machines. Ces données peuvent être assez volumineuses selon l’entreprise. |
Option 3 | Vous gérez vous-même le client de l’API WhatsApp Business étant client direct de WhatsApp et vous transférez le client de l’API WhatsApp Business et les données vers une autre machine. | Cette option a le temps d’arrêt le plus long par rapport aux autres options car les données du client doivent être transférées entre les machines dans leur intégralité. Ces données peuvent être assez volumineuses selon l'entreprise. |
Option 1 : Paramètres uniquement
Lors de la migration des paramètres uniquement, seules les paramètres sont sauvegardés et restaurés. Les messages et les tokens d’authentification ne sont pas migrés.
Étape 1 : Installer une nouvelle configuration
Configurez votre nouveau client de l’API WhatsApp Business à l’aide de la documentation sur l’installation.
Étape 2 : Obtenir un nouveau token d’authentification pour la nouvelle configuration
Le token d’authentification actuel ne sera pas valide dans un nouvel environnement. Connectez-vous à la nouvelle configuration pour obtenir un nouveau token d’authentification.
Étape 3 : Nettoyer
- [Facultatif] Désactiver l’authentification à deux facteurs. Ceci est utile lorsque vous avez oublié le code d'authentification à deux facteurs et que vous devez vous réinscrire. Bien que la réinscription ne soit pas nécessaire pour une migration fluide, il est possible que vous deviez vous réinscrire si la sauvegarde et la restauration échouent pour une raison inconnue. Suivez les instructions pour désactiver le code d’authentification à deux facteurs.
Remarque : si vous êtes sûr que votre code d’authentification à deux facteurs est correct, cette étape est facultative. - [Facultatif] Réinitialiser tous les Webhooks. Si les Webhooks sont configurés pour recevoir des notifications entrantes et que le serveur Webhook est également modifié pendant la migration, désactivez l’ancien serveur Webhook dans les Paramètres de l’application.
Remarque : cette étape est facultative si vous ne modifiez pas le serveur Webhook après la migration.
Étape 4 : Sauvegarder les paramètres à partir de la configuration actuelle
Utilisez le token d’authentification actuel pour sauvegarder les paramètres du client actuel de l’API WhatsApp Business.
Étape 5 : Désinstaller la configuration actuelle
Cela entraîne un temps d’arrêt pour la messagerie. Pour le minimiser, assurez-vous que le client de l’API WhatsApp Business est prêt à être exécuté dans le nouvel emplacement. Reportez-vous à la section Désinstallation du guide d'installation correspondant pour obtenir des instructions. Veillez à ne désinstaller que le client de l’API WhatsApp Business, qui inclut les conteneurs Docker de Coreapp, Webapp et Maître. Ne supprimez pas la base de données.
Étape 6 : Restaurer les paramètres dans la nouvelle configuration
Connectez-vous si vous n’utilisez pas déjà un nouveau token d’authentification et effectuez une restauration sur la nouvelle configuration.
Votre nouveau client de l’API WhatsApp Business devrait fonctionner avec toutes les informations nécessaires et être prêt pour la messagerie. Veillez à ne pas oublier que le réenregistrement du compte WhatsApp n’est pas obligatoire si les paramètres sont sauvegardés et restaurés correctement.
Étape 7 : Contrôler l’état
Contrôlez l’état et envoyez un message de test afin de vérifier le fonctionnement du client de l’API WhatsApp Business.
Étape 8 : [Facultatif] Activer la vérification à deux facteurs
Si vous l’avez désactivée à l’Étape 3, activez de nouveau la vérification à deux facteurs maintenant. Cela offre une sécurité supplémentaire pour votre compte WhatsApp.
Étape 9 : Configurer des Webhooks
Configurez vos Webhooks pour activer les notifications entrantes.
Étape 10 : Supprimer l’ancienne base de données
Votre ancienne base de données contient vos anciens paramètres, vos anciens messages et vos anciens tokens d’authentification. Si vous souhaitez récupérer ces données ultérieurement, ne supprimez pas l’ancienne base de données. Une fois que vous avez décidé de supprimer la base de données, assurez-vous d’abord que le client de l’API WhatsApp Business fonctionne depuis au moins 14 jours et que la messagerie fonctionne correctement.
Option 2 : Paramètres et Messages
Lors de la migration des paramètres et des messages, les paramètres et les messages sont sauvegardés et restaurés. Les tokens d'authentification ne sont pas migrés.
Soyez attentif à la quantité de données devant être transférée vers une autre machine. Puisque davantage de données doivent être sauvegardées et restaurées, le temps d’arrêt est relativement plus long que celui de l’Option 1. La durée totale du temps d’arrêt varie en fonction de la quantité de données transférées et des latences du réseau.
Étape 1 : Nettoyer
- [Facultatif] Désactiver l’authentification à deux facteurs. Ceci est utile lorsque vous avez oublié le code d'authentification à deux facteurs et que vous devez vous réinscrire. Bien que la réinscription ne soit pas nécessaire pour une migration fluide, il est possible que vous deviez vous réinscrire si la sauvegarde et la restauration échouent pour une raison inconnue. Suivez les instructions pour désactiver le code d’authentification à deux facteurs.
Remarque : si vous êtes sûr que votre code d’authentification à deux facteurs est correct, cette étape est facultative. - [Facultatif] Réinitialiser tous les Webhooks. Si les Webhooks sont configurés pour recevoir des notifications entrantes et que le serveur Webhook est également modifié pendant la migration, désactivez l'ancien serveur Webhook dans les Paramètres de l'application. C’est la première fois que la messagerie subit un temps d’arrêt.
Remarque : cette étape est facultative si vous ne modifiez pas le serveur Webhook après la migration.
Étape 2 : Désinstaller la configuration actuelle
Cela entraîne un temps d’arrêt pour la messagerie. Pour le minimiser, assurez-vous que le client de l’API WhatsApp Business est prêt à être exécuté dans le nouvel emplacement. Reportez-vous à la section Désinstallation du guide d’installation correspondant pour obtenir des instructions. Veillez à ne désinstaller que le client de l’API WhatsApp Business. Ne supprimez pas la base de données.
Étape 3 : Sauvegarder la base de données
Sauvegardez toutes les bases de données sauf waweb, qui contient des données d’utilisateurs/d’authentification, en utilisant un utilitaire tel que mysqldump ou pg_dump du client actuel de l’API WhatsApp Business.
Remarque : il est important d’exclure waweb si vous êtes un fournisseur de services qui migre une entreprise vers ou depuis votre plate-forme. Vous ne souhaitez probablement pas reporter ou transférer les tokens d’authentification et les informations des utilisateurs actuellement stockés.
Étape 4 : Restaurer la base de données
Restaurez la base de données en utilisant un utilitaire tel que mysqldump ou pg_dump sur le nouveau client de l’API WhatsApp Business.
Étape 5 : Installer une nouvelle configuration
Configurez votre nouveau client de l’API WhatsApp Business à l’aide de la documentation sur l’installation. Veillez à ce que votre base de données pointe vers l’emplacement restauré à l’Étape 4.
Étape 6 : Obtenir un nouveau token d’authentification pour la nouvelle configuration
Le token d’authentification actuel ne sera pas valide dans un nouvel environnement. Connectez-vous à la nouvelle configuration pour obtenir un nouveau token d’authentification.
Votre nouveau client de l’API WhatsApp Business devrait fonctionner avec toutes les informations nécessaires et être prêt pour la messagerie. Veillez à ne pas oublier que le réenregistrement du compte WhatsApp n’est pas nécessaire si la base de données est sauvegardée et restaurée correctement.
Étape 7 : Contrôler l’état
Contrôlez l’état et envoyez un message de test afin de vérifier le fonctionnement du client de l’API WhatsApp Business.
Étape 8 : [Facultatif] Activer la vérification à deux facteurs
Si vous l’avez désactivée à l’Étape 1, activez de nouveau la vérification à deux facteurs maintenant. Cela offre une sécurité supplémentaire pour votre compte WhatsApp.
Étape 9 : Configurer des Webhooks
Configurez vos Webhooks pour activer les notifications entrantes.
Étape 10 : Supprimer l’ancienne base de données
Votre ancienne base de données contient vos anciens paramètres, vos anciens messages et vos anciens tokens d’authentification. Si vous souhaitez récupérer ces données ultérieurement, ne supprimez pas l’ancienne base de données. Une fois que vous avez décidé de supprimer la base de données, assurez-vous d’abord que le client de l’API WhatsApp Business fonctionne depuis au moins 14 jours et que la messagerie fonctionne correctement.
Option 3 : Migration complète
Au cours d'une migration complète, tous les paramètres, les messages et les tokens d'authentification sont sauvegardés et restaurés.
Cette option peut sembler être la meilleure mais soyez attentif à la quantité de données devant être transférée vers une autre machine. Puisque davantage de données doivent être sauvegardées et restaurées, le temps d’arrêt est relativement plus long que celui des Options 1 et 2.
Étape 1 : Nettoyer
- [Facultatif] Désactiver l’authentification à deux facteurs. Ceci est utile lorsque vous avez oublié le code d'authentification à deux facteurs et que vous devez vous réinscrire. Bien que la réinscription ne soit pas nécessaire pour une migration fluide, il est possible que vous deviez vous réinscrire si la sauvegarde et la restauration échouent pour une raison inconnue. Suivez les instructions pour désactiver le code d’authentification à deux facteurs.
Remarque : si vous êtes sûr que votre code d’authentification à deux facteurs est correct, cette étape est facultative.
Étape 2 : Sauvegarder votre token d’authentification actuel
La validité maximale d’un token est de 7 jours. Veuillez vous assurer que votre token dure assez longtemps afin de pouvoir effectuer la migration.
Étape 3 : Désinstaller la configuration actuelle
Cela entraîne un temps d’arrêt de la messagerie. Pour le minimiser, assurez-vous que le client de l’API WhatsApp Business est prêt à être exécuté dans le nouvel emplacement. Reportez-vous à la section Désinstallation du guide d’installation correspondant pour obtenir des instructions. Veillez à ne désinstaller que le client de l’API WhatsApp Business. Ne supprimez pas la base de données.
Étape 4 : [Facultatif] Sauvegarder la base de données
Sauvegardez la base de données en utilisant un utilitaire tel que mysqldump ou pg_dump ou pour capturer les paramètres, les messages et les tokens authentification.
Remarque : si vous migrez uniquement le client de l’API WhatsApp Business mais pas la base de données, cette étape est facultative.
Étape 5 : Restaurer la base de données
Restaurez la base de données en utilisant un utilitaire tel que mysqldump ou pg_dump sur le nouveau client de l’API WhatsApp Business.
Étape 6 : Installer une nouvelle configuration
Configurez votre nouveau client de l’API WhatsApp Business à l’aide de la documentation sur l’installation. Veillez à ce que votre base de données pointe vers l’emplacement restauré à l’Étape 5.
Votre nouveau client de l’API WhatsApp Business devrait fonctionner avec toutes les informations nécessaires et être prêt pour la messagerie. Veillez à ne pas oublier que le réenregistrement du compte WhatsApp n’est pas nécessaire si les données sont sauvegardées et restaurées correctement.
Étape 7 : Contrôler l’état
Contrôlez l’état et envoyez un message de test afin de vérifier le fonctionnement du client de l’API WhatsApp Business.
Étape 8 : [Facultatif] Activer la vérification à deux facteurs
Si vous l’avez désactivée à l’Étape 1, activez de nouveau la vérification à deux facteurs maintenant. Cela offre une sécurité supplémentaire pour votre compte WhatsApp.
Étape 9 : Configurer des Webhooks
Configurez vos Webhooks pour activer les notifications entrantes.
Étape 10 : Supprimer l’ancienne base de données
Votre ancienne base de données contient vos anciens paramètres, vos anciens messages et vos anciens tokens d’authentification. Si vous souhaitez récupérer ces données ultérieurement, ne supprimez pas l’ancienne base de données. Une fois que vous avez décidé de supprimer la base de données, assurez-vous d’abord que le client de l’API WhatsApp Business fonctionne depuis au moins 14 jours et que la messagerie fonctionne correctement.