Premiers pas

Ce tutoriel décrit comment configurer votre client de l’API On-Premises, enregistrer un numéro de téléphone professionnel, mettre à jour vos paramètres et envoyer un message de test.

Le processus de démarrage avec l’API peut être divisé en trois étapes :

1. Préparer les éléments : avant de commencer, vous devez configurer les éléments requis pour réaliser l’intégration de l’API, notamment le compte WhatsApp Business.
2. Installer l’API On-Premises : installer le client de l’API. Une fois que le client est opérationnel, vous pouvez mettre à jour les paramètres de votre application.
3. Commencer à utiliser le client : enregistrer votre numéro de téléphone avec un appel d’API vers /account et envoyer un message de test avec un appel vers /messages.

Avant de commencer

Versions recommandées du logiciel

Étape 1 : installation du client de l’API On-Premises

Environnement

Le client de l’API On-Premises est essentiellement fondé sur Docker. Consultez la page Architecture du client pour en savoir plus sur chaque composant.

Équipement

Le client de l’API On-Premises fonctionnera sur toute machine connectée à Internet et exécutant Docker pour Linux, soit sur une machine virtuelle, soit sur le serveur Linux. Pour plus d’informations, consultez les Questions/réponses. Vous pouvez, par exemple, effectuer des tests simples sur un ordinateur portable. Nous préconisons au minimum un SSD de 250 Go, 16 Go de RAM et un processeur 4 cœurs pour un serveur d’environnement de production. L’utilisation d’un disque dur n’est pas recommandée, car les vitesses d’entrée-sortie deviendront des goulots d’étranglement une fois le serveur en charge.

Dans la plupart des cas, vous devrez exécuter la base de données sur un serveur physiquement séparé des conteneurs de l’application principale et de l’application web. La latence entre le serveur de base de données et la ou les machines de calcul ne doit être que de quelques millisecondes.

Installation

Il existe deux moyens de bien démarrer avec l’API On-Premises :

• Installation sur site : vous pouvez configurer les conteneurs Docker par vos propres moyens à l’aide de notre guide d’installation. Nous vous recommandons de commencer par l’une des configurations de développement pour vous familiariser avec le processus de configuration et l’envoi de messages. Vous pouvez utiliser cette solution sur site sur votre ordinateur avant d’en effectuer la migration vers un environnement de production.
• Amazon Web Services (AWS) : si vous utilisez AWS ou souhaitez une solution plus autonome, consultez notre guide d’AWS. La solution AWS déploie une version complète de l’API On-Premises, avec des fonctions de sauvegarde, de récupération et bien d’autres encore, au sein d’un Cloud AWS que vous détenez et gérez vous-même.

Mise à jour de vos paramètres

Vous pouvez modifier les paramètres de l’application une fois que le client de l’API On-Premises fonctionne. Cependant, vous ne pouvez pas accéder aux différents paramètres de profil de votre client de l’API On-Premises tant que l’inscription n’est pas terminée.

• Les paramètres d’application concernent le fonctionnement du client : paramètres de rappel, Webhooks, avertisseur d’appel, statut envoyé, comportement de téléchargement de contenus multimédias, etc. Remarque : Il est fortement recommandé de configurer une URL de Webhook afin de recevoir des notifications sur les messages entrants ou les erreurs.
• Les paramètres de profil professionnel et les paramètres de profil contiennent les informations de votre entreprise telles que l’adresse postale, l’adresse e-mail, le site web, le secteur d’activité, les informations À propos et la photo de profil.

Étape 2 : premiers pas avec le client

Enregistrement

Une fois que le client de l’API On-Premises est opérationnel, vous pouvez enregistrer votre numéro de téléphone en envoyant un appel d’API au point de terminaison account.

Envoi d’un message de test

Vous pouvez envoyer des messages de test à l’aide du point de terminaison messages. Vérifiez au préalable le statut du numéro de téléphone que vous utilisez pour le test. Vous devrez envoyer à votre compte WhatsApp un message à partir du numéro de téléphone de test pour activer la fenêtre du service clientèle, qui vous permet d’envoyer tout type de message au cours d’une période de 24 heures (consultez la rubrique Contrôle de diffusion pour plus de détails). Envoyez ensuite un texto à votre numéro de téléphone de test. Si le message arrive, cela signifie que l’installation a réussi. Si ce n’est pas le cas, vérifiez dans votre compte Webhook les notifications qui peuvent indiquer un problème.

Sécurité

Consultez notre guide Sécurité pour plus d’informations sur les mots de passe, l’authentification, la configuration SSL, la séparation de réseaux, les communications chiffrées, les en-têtes HTTP et le protocole TLS des serveurs web en ce qui concerne le client de l’API On-Premises.

Processus d’initialisation

L’API WhatsApp On-Premises passe par une procédure d’initialisation lors de l’établissement de la connexion avec le serveur. Ce processus est essentiel pour garantir un moyen fluide et fiable d’envoyer et de recevoir des messages. Pendant cette phase d’initialisation, l’application de base (coreapp) attend que plusieurs conditions requises soient remplies, notamment :

• Chargement des messages de modèle : l’API charge des messages de modèle à partir du serveur dans le cadre du processus d’initialisation.

• Réception et traitement de messages hors ligne : elle gère également la réception et le traitement de messages hors ligne.

Si des tentatives d’envoi de messages ont lieu alors que les conditions requises ne sont pas remplies, l’application de base répond avec un message d’erreur indiquant que coreapp n’est pas prêt et les journaux affichent une erreur signalant que le service n’est pas prêt. Il est important de noter que ce processus d’initialisation est effectué chaque fois qu’une nouvelle connexion au serveur WhatsApp est établie. Par conséquent, si l’application de base est redémarrée ou subit une déconnexion, le processus d’initialisation sera à nouveau lancé pour définir l’état de coreapp sur « prêt ». Ce fonctionnement permet de garantir la fiabilité et la disponibilité de l’API WhatsApp On-Premises pour la communication des messages.

Traitement des messages hors ligne

S’il n’existe aucun message hors ligne, l’étape de traitement de ce type de message n’apparaît pas. Autrement dit, si aucun message présentant l’état hors ligne n’est en attente, cette phase de la gestion des messages est omise.

En temps normal, l’API WhatsApp On-Premises suit un protocole standard de gestion des messages hors ligne. Elle attend que tous les messages hors ligne soient reçus et traités, avec un délai maximal prédéfini de 6 minutes. Une fois les 6 minutes écoulées, la phase de traitement des messages hors ligne est considérée comme terminée avec succès.

Suggestions supplémentaires

Si nous détectons que vous avez enfreint l’une de nos règles ou politiques, nous nous réservons le droit de limiter ou de supprimer votre accès à WhatsApp.

En savoir plus

• Configuration avancée
• Collection Postman
• Plateforme WhatsApp Business
• Changelog de la plateforme WhatsApp Business