Documentation API — WhatsApp Link Guard

Documentation publique · API v1

Automatisez WhatsApp avec une API claire et complète.

Pilotez les sessions, envoyez des messages, gérez les groupes et consultez l’activité du bot depuis vos propres applications.

Faire un premier appel Explorer les opérations Obtenir une clé API

REST v1Interface versionnée et prévisible

64Opérations documentées

OpenAPI 3.1Contrat lisible par vos outils

Point d’entrée

URL de base

Ajoutez le chemin d’une opération à cette adresse. La version reste intégrée à l’URL pour protéger vos intégrations des changements incompatibles.

Environnement courant

API v1

http://localhost:3000/api/v1

Cette page est publique

Vous pouvez consulter la référence sans vous connecter. Pour un compte standard, le portail, les clés et les opérations métier exigent un plan API actif ; l’administrateur conserve son accès.

Démarrage rapide

Votre premier appel en trois étapes

Les exemples contiennent uniquement des valeurs fictives. Remplacez-les côté serveur par vos propres identifiants.

1

Activez le plan API

Pour un compte standard, souscrivez ou renouvelez le plan API avant de provisionner une intégration. Cette étape est contournée pour l’administrateur.

2

Créez une clé

Depuis le portail privé, nommez votre intégration et copiez le secret affiché une seule fois.

3

Ciblez une session couverte

Utilisez une session dont subscription.active vaut true, puis transmettez la clé dans l’en-tête X-API-Key.

Lister les sessions · cURL

curl 'http://localhost:3000/api/v1/sessions' \
  -H 'Accept: application/json' \
  -H 'X-API-Key: VOTRE_CLE_API'

Sécurité

Authentification

La majorité des opérations accepte une clé API. Certaines opérations sensibles de gestion du compte exigent une session utilisateur.

Accéder à mes clés

Clé API — intégrations

Méthode recommandée pour un CRM, un backend, une automatisation ou un service tiers autorisé.

X-API-Key: VOTRE_CLE_API

Jeton de compte — administration

Réservé aux opérations du compte, notamment la création, la rotation, la révocation et la suppression définitive des clés.

Authorization: Bearer VOTRE_JETON_DE_COMPTE

Cycle de l’abonnement API. Pour un compte standard, à l’expiration, toutes les clés non révoquées sont suspendues et les requêtes répondent 402 API_PLAN_REQUIRED. Elles ne sont ni supprimées ni tournées : le renouvellement du plan API réactive automatiquement les mêmes secrets. Une clé explicitement révoquée reste définitivement invalide. L’administrateur conserve son accès. Activer ou renouveler le plan API.

Suppression d'une clé révoquée. DELETE /api/v1/api-keys/:keyId/purge efface définitivement son empreinte (hash) et ses métadonnées. Une session de compte est requise. La route répond 409 si la clé est encore active et 404 si elle est introuvable.

Gardez vos secrets côté serveur en production. Le testeur ci-dessous accepte temporairement une clé ou un jeton dans la mémoire de cet onglet, l’envoie uniquement à l’API courante et ne l’enregistre jamais dans le stockage du navigateur. Ne placez jamais un secret dans une URL ou dans votre code public.

Contrat OpenAPI

Explorateur des opérations

Les endpoints suivent l’ordre conseillé d’une intégration complète. Chaque opération présente ses paramètres, son corps JSON, ses réponses et un testeur exécutable placé à droite.

OpenAPI JSON

Chargement du contrat OpenAPI…

Parcours recommandéSuivez les étapes de haut en bas. Les opérations de lecture précèdent les modifications et les suppressions restent en fin de cycle.

P0 · EssentielP1 · ImportantP2 · AvancéRéférence