API On-Premises de la plateforme WhatsApp Business

Connexion

/v1/users/login

Pour vous authentifier avec le client de l’API WhatsApp Business, vous devez vous connecter. Pour vous connecter, envoyez votre nom d’utilisateur et votre mot de passe par le biais d’une authentification de base. Vous recevrez un token bearer en réponse. Utilisez ensuite le token bearer pour vous authentifier lorsque vous envoyez des demandes à n’importe quel point de terminaison de l’API WhatsApp Business. En savoir plus sur l’authentification permettant d’utiliser l’API.

Avant de commencer

Le client de l’API WhatsApp Business possède un compte par défaut. Le nom d’utilisateur du compte est admin et le mot de passe est secret. Ce compte ne peut pas être supprimé du système. Pour des raisons de sécurité, vous devez modifier immédiatement le mot de passe administrateur lors de la première connexion.

Recommandations pour le mot de passe

Nous vous recommandons d’utiliser des mots de passe forts lors de la création de comptes et lors de la définition des mots de passe des nouveaux comptes, conformément aux recommandations du secteur.

Les mots de passe doivent comporter entre 8 et 64 caractères et au moins :

  • un chiffre
  • une majuscule
  • une minuscule
  • un caractère spécial parmi ceux-ci !"#$%&\'()*+,-./:;<=>?@[]^_`{|}~

La complexité du mot de passe est renforcée lors de la création d’un compte ou de la modification du mot de passe d’un compte existant.

Création

Vous vous authentifiez en utilisant l’authentification de base (nom d’utilisateur, mot de passe) lorsque vous vous connectez. L’Authorization est définie dans l’en-tête HTTP. Le type est Basic et les credentials sont une chaîne encodée au format Base64 composée d’un username et d’un password séparés par deux points (par exemple, username:password).

Lorsque votre demande de connexion est reçue par le client de l’API WhatsApp Business, vos identifiants sont traités en vue d’être validés.

  • En cas de réussite, votre token est généré. La réponse contient votre token dans le champ token.
  • En cas d’échec, un message d’erreur est renvoyé.

Exemples

Première connexion

Pour des raisons de sécurité, vous devez mettre à jour le mot de passe administrateur par défaut avec un nouveau mot de passe en utilisant le champ new_password la première fois que vous essayez de vous connecter. Le système renvoie un message d’erreur si vous essayez de vous connecter avec le mot de passe par défaut et sans les informations du champ new_password.

Voir la section dédiée aux mots de passe pour découvrir nos recommandations. Votre première connexion devrait ressembler à ce qui suit :

  POST /v1/users/login
  Authorization: Basic base64(username:password)
  {
  "new_password": "new-password"
  }

La version cURL se présente comme suit :

curl -k -X POST https://your-webapp-hostname:your-webapp-port/v1/users/login \
  -w "\n%{http-code}\n" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Basic base64(username:password)' \
  -d '{"new_password" : "new-password"}'

Connexion standard

La connexion standard pour le client de l’API WhatsApp Business se présente comme suit :

POST /v1/users/login
Authorization: Basic base64(username:password)

La version cURL se présente comme suit :

curl -X POST \
  -H 'Authorization: Basic base64(username:password)' \
  -H 'Content-Type: application/json' \
  -d '{}' \
  https://your-webapp-hostname:your-webapp-port/v1/users/login

En cas de réussite, le statut 200 OK est renvoyé, ainsi que le token et sa durée de validité. Tous les tokens générés expirent après 7 jours. La réponse ressemble à l’exemple suivant :

{
   "users": [{
      "token": "eyJhbGciOHlXVCJ9.eyJ1c2VyIjoNTIzMDE2Nn0.mEoF0COaO00Z1cANo",
      "expires_after": "2018-03-01 15:29:26+00:00"
   }]
}

Si la demande n’aboutit pas, le statut HTTP 401 Unauthorized apparaît. Cette erreur signifie généralement que le nom d’utilisateur et/ou le mot de passe envoyés avec la demande de connexion sont non valides. Par conséquent, le client de l’API WhatsApp Business ne peut pas générer le token.

S’il existe des erreurs dans la réponse, consultez les informations suivantes pour plus d’informations : Code d’erreur client WhatsApp Enterprise et Codes de statut HTTP.

Champs renvoyés

Champ Description

token

Obligatoire.

Token d’authentification à utiliser pour tous les autres appels de l’API WhatsApp Business. Le token doit être envoyé dans l’en-tête d’autorisation au format :
Authorization: Bearer <authentication-token>

expires_after

Obligatoire.

Horodatage de l’expiration du token. Par défaut, la durée est de 7 jours.

En savoir plus