API On-Premises de la plateforme WhatsApp Business

L’API On-Premises ne sera bientôt plus disponible. Consultez notre document Abandon progressif de l’API On-Premises pour de plus amples détails, mais aussi pour connaître la procédure de migration vers notre API Cloud nouvelle génération.

Utilisateurs

/v1/users

Utilisez le nœud users pour gérer l’authentification et l’accès au client de l’API On-Premises WhatsApp Business.

Avant de commencer

Le client de l’API On-Premises WhatsApp Business possède un compte par défaut. Le nom d’utilisateur·ice 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 sans attendre le mot de passe administrateur.

Si vous oubliez votre mot de passe, veuillez contacter l’assistance directe pour obtenir de l’aide afin de le réinitialiser.

Restrictions

  • Seul le compte admin peut créer ou supprimer des utilisateur·ices.

Recommandations

  • Utilisez le compte admin uniquement pour créer ou supprimer des utilisateur·ices.
  • Créez des comptes utilisateur·ice pour gérer vos clients de l’API On-Premises WhatsApp Business.

Création

Si vous souhaitez créer un compte pour un·e utilisateur·ice de votre entreprise qui peut accéder à l’API WhatsApp Business, envoyez le nom d’utilisateur·ice et le mot de passe au client de l’API On-Premises WhatsApp Business en utilisant le point de terminaison /users. Cela valide le nom d’utilisateur·ice et le mot de passe et crée un compte s’il n’en existe pas déjà un pour ce nom d’utilisateur·ice. Le mot de passe est traité avec un hachage à sens unique et stocké dans un volume de données. Les paramètres username et password sont obligatoires.

Exemple

Pour créer un·e utilisateur·ice, envoyez une demande du type :

POST /v1/users
Authorization: Bearer your-auth-token

{
  "username": "username",
  "password": "password"
}

Si la demande est acceptée et qu’un compte utilisateur·ice est créé, vous recevez un code d’état HTTP 201 Created et la charge utile suivante :

{
  "users": [{
     "username": "username"
  }]
}

Si la demande n’aboutit pas, vous recevez un code d’état HTTP, ainsi qu’un code d’erreur WhatsApp. Si vous soumettez un nom d’utilisateur·ice en double, vous recevez un message d’erreur du type :

{
  "errors": [{
    "code": 1014,
    "title": "Internal error",
    "details": "Unable to create user. Already exist?"
  }]
}

Paramètres

NomDescription

username

Obligatoire.

Doit comporter au minimum 4 caractères et au maximum 32 caractères.
Établissez un modèle pour username, tel que l’initiale et le nom de famille, afin d'éviter de créer plusieurs comptes pour la même personne.

password

Obligatoire.

Doit comporter entre 8 et 64 caractères dont au moins une lettre en majuscule, une lettre en minuscule, un chiffre et un caractère spécial :


!\/'"#$%&()*+-.,:;_<>=?@[]{}^`|~

Authorization

Obligatoire.

Token d’authentification pour l’admin qui exécute la requête. Pour plus d’informations, consultez la documentation sur la connexion, l’authentification et les tokens.

Arêtes

Les arêtes ci-dessous sont connectées à ce nœud :

ArêteDescription

/users/login

Utilisez cette arête pour vous connecter au client de l’API On-Premises WhatsApp Business.

/users/logout

Utilisez cette arête pour vous déconnecter du client de l’API On-Premises WhatsApp Business.

/users/{username}

Utilisez cette arête pour récupérer, mettre à jour ou supprimer un compte utilisateur·ice.

Erreurs courantes

Code d’état HTTPRaison

400

  • Le mot de passe est trop court (moins de 8 caractères) ou trop long (plus de 64 caractères).
  • Le nom d’utilisateur·ice est trop court (moins de 4 caractères) ou trop long (plus de 32 caractères).

Soumettez à nouveau la demande avec un nom d’utilisateur·ice/mot de passe de longueur appropriée.

403

Vous n’utilisez pas le compte admin pour créer le compte utilisateur·ice.

500

Impossible de créer le compte, probablement parce qu’il existe déjà.

S’il existe d’autres erreurs dans la réponse, consultez les sources suivantes pour plus d’informations : Codes d’erreur et Codes d’état HTTP.