Référence API

Tout ce dont vous avez besoin pour intégrer Whappi dans vos applications de manière sécurisée et efficace.

Vue d'ensemble

Ce document fournit des instructions détaillées et axées sur les développeurs pour l'utilisation de l'API WhatsApp. Pour des tests interactifs, nous vous recommandons d'utiliser l'outil Quick Message sur le tableau de bord.

EnvironnementURL de base API V1URL de base API Legacy
Développement Localhttp://localhost:3000/api/v1http://localhost:3000/api
Production (HTTPS)https://api.votre-domaine.com/api/v1https://api.votre-domaine.com/api

Authentification

Toutes les requêtes API vers les points de terminaison /api/v1/* doivent être authentifiées à l'aide d'un jeton Bearer.

Jeton Bearer
Incluez le jeton dans votre en-tête Authorization pour chaque requête.
http
Authorization: Bearer <votre_api_token>

Gestion des Sessions

POST/sessions

Créer une Session

Crée une nouvelle session WhatsApp avec un identifiant unique. Nécessite une clé API Master ou une authentification administrateur.

Corps de la Requête
json
{
  "sessionId": "maSession"
}
Exemple cURL
bash
curl -X POST 'http://localhost:3000/api/v1/sessions' \
-H 'X-Master-Key: votre-cle-master' \
-H 'Content-Type: application/json' \
-d '{"sessionId": "maSession"}'
GET/sessions

Lister les Sessions

Récupère toutes les sessions actives et leur statut actuel. Aucune authentification requise.

bash
curl -X GET 'http://localhost:3000/api/v1/sessions'

Messagerie

POST/messages

Envoyer un Message

Envoyez divers types de messages, notamment du texte, des images, de l'audio, de la vidéo et des documents.

bash
curl -X POST 'http://localhost:3000/api/v1/messages?sessionId=maSession' \
-H 'Authorization: Bearer votre_token' \
-H 'Content-Type: application/json' \
-d '{
  "recipient_type": "individual",
  "to": "6281234567890",
  "type": "text",
  "text": { "body": "Bonjour le monde" }
}'

Webhooks

POST/webhook

Définir l'URL du Webhook

Configurez l'endroit où le serveur envoie les notifications d'événements.

bash
curl -X POST 'http://localhost:3000/api/v1/webhook' \
-H 'Authorization: Bearer votre_token' \
-H 'Content-Type: application/json' \
-d '{
  "sessionId": "maSession",
  "url": "https://votre-webhook.com/handler"
}'

Gestion des Médias

POST/media/upload

Télécharger un Média

Téléchargez un fichier pour obtenir un identifiant ou un lien média à utiliser dans les messages.

bash
curl -X POST 'http://localhost:3000/api/v1/media/upload' \
-H 'Authorization: Bearer votre_token' \
-F 'file=@/chemin/vers/votre/fichier.jpg'