Premiers pas pour les fournisseurs de solutions partenaires

Ce guide passe en revue les étapes que les fournisseurs de solutions partenaires doivent mener à bien pour proposer l’API Cloud à leur clientèle. Il existe quatre étapes principales :

1. Préparation et planification
2. Configuration des ressources
3. Signature des contrats
4. Création de l’intégration

Une fois ces étapes accomplies, veuillez procéder aux mises à jour mensuelles demandées.

Préparation et planification

Lire la documentation

Avant de commencer, nous vous recommandons de parcourir la documentation réservée aux équipes de développement et notre collection Postman. Cela vous aidera à comprendre le fonctionnement de l’API Cloud, notamment comment démarrer et migrer les numéros.

Planifier l’intégration et la migration

Vous devez utiliser l’inscription intégrée pour intégrer une nouvelle clientèle dans l’API Cloud. Si cela n’est pas déjà fait, intégrez et lancez l’inscription intégrée. Celle-ci constitue le moyen d’inscription le plus simple et le plus rapide. Elle permet également de commencer à envoyer des messages en moins de cinq minutes.

Ensuite, réfléchissez aux clients et clientes que vous voulez commencer par migrer dans l’API Cloud. De manière générale, si nous recommandons de tous et toutes les migrer de l’API On-Premises vers l’API Cloud, les besoins de chacun et chacune peuvent varier. Pour vous décider, tenez compte des points suivants :

Dès que vous savez qui sera migré, vous pouvez créer un plan et un calendrier de migration.

Une fois le plan créé, n’oubliez pas de concevoir votre système pour deux scénarios : l’intégration d’une nouvelle clientèle et la migration des clients et clientes existant·es de l’API On-Premises vers l’API Cloud. Concernant le scénario de migration, prévoyez des plans pour sauvegarder votre instance On-Premises et migrer ces numéros dans l’API Cloud.

Communiquer le plan aux clients et clientes

Tout d’abord, vous devez décider si vous souhaitez informer les clients et clientes existant·es de la migration. Ensuite, vous devez déterminer si créer ou mettre à jour la documentation pour prendre en charge la configuration de l’API Cloud.

Décider des tarifs

Étant donné que les coûts d’hébergement pour l’API Cloud sont couverts par Meta, mieux vaut décider s’il conviendrait de mettre à jour vos tarifs en conséquence.

Configuration des ressources

Pour utiliser l’API Cloud, les fournisseurs de solutions partenaires doivent posséder les ressources suivantes :

Signature des contrats

Accepter les conditions d’utilisation

Pour pouvoir accéder à l’API Cloud pour le service de messagerie WhatsApp Business, vous devez commencer par accepter les conditions d’utilisation de la plateforme WhatsApp Business pour le compte de votre entreprise.

Pour cela, accédez au Gestionnaire WhatsApp, puis acceptez les conditions d’utilisation dans la bannière des informations.

Si vous utilisez déjà la version bêta de l’API Cloud, vous bénéficiez d’un délai de grâce de 90 jours. Cela signifie que vous avez jusqu’au 5 juillet 2022 pour accepter les conditions, sous peine de voir votre accès révoqué.

Concernant les entreprises qui utilisent l’API Cloud pour la première fois, y compris celles qui effectuent une migration depuis l’API On-Premises, il convient de commencer par accepter les conditions d’utilisation. Les appels d’inscription échouent tant que vous n’avez pas accepté les conditions d’utilisation.

Création de l’intégration

Étape 1 : Obtenir un token d’accès utilisateur système

Les appels d’API Graph utilisent les tokens d’accès pour l’authentification. Pour en savoir plus, consultez la page Tokens d’accès. Nous vous recommandons d’utiliser votre utilisateur·ice système pour générer le token.

Pour générer un token d’accès utilisateur·ice système :

1. Accédez à Business Manager > Paramètres d’entreprise > Utilisateurs > Utilisateurs système pour afficher l’utilisateur·ice système créé·e.
2. Cliquez sur cet·te utilisateur·ice et sélectionnez Ajouter des ressources. Une nouvelle fenêtre s’ouvre alors.
3. Sous Sélectionner le type de ressources dans le volet de gauche, sélectionnez Applications. Sous Sélectionner les ressources, choisissez l’application Meta à utiliser (vous devez posséder les autorisations appropriées pour cette application). Cochez Développer l’application pour cette application.
4. Sélectionnez Enregistrer les modifications pour enregistrer les paramètres et revenir à l’écran principal des utilisateur·ices système.
5. Vous pouvez maintenant générer le token. Dans l’écran principal des utilisateur·ices système, cliquez sur Générer un token et sélectionnez votre application Meta. Une fois l’application sélectionnée, vous accédez à une liste des autorisations disponibles. Sélectionnez whatsapp_business_management et whatsapp_business_messaging. Cliquez sur Générer un token.
6. Une nouvelle fenêtre s’ouvre, laquelle contient votre utilisateur·ice système, l’application affectée et le token d’accès. Enregistrez le token.
7. Vous pouvez éventuellement cliquer sur ce token pour afficher le débogueur de tokens d’accès. Dans cet outil, les deux autorisations sélectionnées s’affichent. Vous pouvez également directement coller le token dans le débogueur de tokens d’accès.

Étape 2 : Configurer des Webhooks

En configurant des webhooks, vous recevez des notifications HTTP en temps réel de la plateforme WhatsApp Business. Par exemple, cela signifie qu’une notification vous parvient quand vous recevez un message d’un client ou d’une cliente ou que des changements ont été apportés à votre compte WhatsApp Business.

Pour configurer votre webhook, vous devez créer un serveur web avec accès Internet en utilisant une URL qui répond aux exigences de Meta et de WhatsApp. Pour savoir comment faire, consultez la page Création d’un point de terminaison. À des fins de test, vous pouvez aussi générer un point de terminaison de webhook de test.

Configuration de l’application

Une fois que le point de terminaison est prêt, configurez-le pour l’utiliser avec votre application Meta :

Il vous suffit de configurer les webhooks une seule fois pour chacune des applications en votre possession. Vous pouvez utiliser le même webhook pour recevoir plusieurs types d’évènements de plusieurs comptes WhatsApp Business. Pour en savoir plus, consultez notre section sur les Webhooks.

Étape 3 : Vous abonner à votre compte WhatsApp Business

Pour avoir la garantie de recevoir les notifications du compte correspondant, abonnez votre application :

curl -X POST \
'https://graph.facebook.com/v19.0/WHATSAPP_BUSINESS_ACCOUNT_ID/subscribed_apps' \
-H 'Authorization: Bearer ACCESS_TOKEN'

Si vous obtenez la réponse ci-dessous, tous les évènements webhook pour les numéros de téléphone inscrits dans ce compte seront envoyés au point de terminaison de webhook configuré.

{
  "success": true
}

Étape 4 : Obtenir l’ID du numéro de téléphone

Pour envoyer des messages, vous devez inscrire le numéro de téléphone à utiliser. Il s’agit du numéro de téléphone de l’entreprise que nous avons mentionné dans la section Avant de commencer.

Avant de procéder à l’inscription, vous devez rechercher l’ID de ce numéro de téléphone. Pour l’obtenir, lancez l’appel API suivant :

curl -X GET \
'https://graph.facebook.com/v19.0/WHATSAPP_BUSINESS_ACCOUNT_ID/phone_numbers' \
-H 'Authorization: Bearer ACCESS_TOKEN'

Si la demande aboutit, la réponse inclut tous les numéros de téléphone connectés à votre compte WhatsApp Business :

{
  "data": [
    {
      "verified_name": "Jasper's Market",
      "display_phone_number": "+1 631-555-5555",
      "id": "1906385232743451",
      "quality_rating": "GREEN"
    },
    {
      "verified_name": "Jasper's Ice Cream",
      "display_phone_number": "+1 631-555-5556",
      "id": "1913623884432103",
      "quality_rating": "NA"
    }
  ]
}

Enregistrez l’ID du numéro de téléphone à inscrire. Pour en savoir plus sur ce point de terminaison, consultez la page Lecture des numéros de téléphone.

Exception concernant la migration

Étape 5 : Inscrire un numéro de téléphone

Si vous possédez l’ID du numéro de téléphone, vous pouvez l’inscrire. Dans l’appel d’API pour l’inscription, vous réalisez simultanément deux actions :

1. Vous inscrivez le numéro de téléphone.
2. Vous activez la vérification en deux étapes en définissant un code d’inscription à six chiffres. Ce code doit être défini par vos soins. Enregistrez et mémorisez ce code, car il pourra être demandé par la suite.

La configuration de l’authentification à deux facteurs est obligatoire pour pouvoir utiliser l’API Cloud. Dans le cas contraire, vous recevrez un message d’erreur d’intégration :

Exemple de requête :

curl -X POST \
'https://graph.facebook.com/v19.0/FROM_PHONE_NUMBER_ID/register' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"messaging_product": "whatsapp","pin": "6_DIGIT_PIN"}'

Exemple de réponse :

{
  "success": true
}

Inscription intégrée

Étape 6 : Recevoir un message d’une application utilisée par les consommateurs et consommatrices

Dès que les clients et clientes participant envoient un message à votre entreprise, vous pouvez leur répondre gratuitement pendant 24 heures. Cette fenêtre est appelée fenêtre de service clientèle. À des fins de test, nous voulons activer cette fenêtre pour vous permettre d’envoyer autant de messages que souhaité.

Depuis une application WhatsApp personnelle sous iOS ou Android, envoyez un message au numéro de téléphone que vous venez d’inscrire. Une fois le message envoyé, vous devriez recevoir un message entrant sur votre webhook avec une notification dont le format correspond à celui indiqué ci-après.

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "16315551234",
              "phone_number_id": "PHONE_NUMBER_ID"
            },
            "contacts": [
              {
                "profile": {
                  "name": "Kerry Fisher"
                },
                "wa_id": "16315555555"
              }
            ],
            "messages": [
              {
                "from": "16315555555",
                "id": "wamid.ABGGFlA5FpafAgo6tHcNmNjXmuSf",
                "timestamp": "1602139392",
                "text": {
                  "body": "Hello!"
                },
                "type": "text"
                }
            ]
          },
        "field": "messages"
        }
      ]
    }
  ]
}

Étape 7 : Envoyer un message de test

Dès que vous avez activé la fenêtre de service clientèle, vous pouvez envoyer un message de test au numéro à destination des consommateurs et consommatrices utilisé à l’étape précédente. Pour ce faire, exécutez l’appel d’API suivant :

curl -X  POST \
'https://graph.facebook.com/v19.0/FROM_PHONE_NUMBER_ID/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"messaging_product": "whatsapp", "to": "16315555555","text": {"body" : "hello world!"}}'

Si votre appel aboutit, la réponse intégrera un ID de message. Utilisez cet ID pour suivre la progression de vos messages via les Webhooks. La longueur maximale autorisée pour l’ID est de 128 caractères.

Exemple de réponse :

{
  "id":"wamid.gBGGFlaCGg0xcvAdgmZ9plHrf2Mh-o"
}

Mises à jour mensuelles

Nous publierons les mises à jour de l’API Cloud le premier mardi de chaque mois. Ces mises à jour intégreront de nouvelles fonctionnalités et améliorations. L’API Cloud étant automatiquement mise à jour, vous n’avez pas à intervenir pour utiliser ces nouvelles fonctionnalités.

Questions/réponses

Questions/réponses d’ordre général

Questions/réponses sur l’implémentation technique

What is the architecture of the Cloud API?

The Cloud API architecture significantly simplifies the Solution Partner's operational and infrastructure requirements to integrate with WhatsApp Business Platform. First, it removes the infrastructure requirements to run Business API docker containers (CAPEX savings). Second, it obviates the need of operational responsibilities to manage the deployment (OPEX savings). For details, refer to the architecture diagram comparing the On-Premises and Cloud API deployments.

Permalien

Questions/réponses sur la confidentialité des données et la sécurité

Questions/réponses sur la conformité réglementaire