Documentation API

Documentation complète des endpoints pour l'API de messagerie. Utilisez cette référence pour intégrer les services d'email, SMS et WhatsApp dans vos applications.

Authentification

Toutes les requêtes à l'API nécessitent une authentification via les headers suivants :

Authorization

Token d'autorisation (Bearer token)

TokenKey

Clé secrète pour la validation

POST

/messages/email

Envoyer un nouveau message par email

Description

Endpoint pour envoyer des emails à un ou plusieurs destinataires. Supporte les templates personnalisés et les liens de redirection.

Paramètres de la requête

Paramètre	Type	Obligatoire	Description
sender	Object	Oui	Informations sur l'expéditeur
sender.username	String	Oui	Nom de l'expéditeur
sender.email	String	Oui	Email de l'expéditeur
recipients	Array	Oui	Liste des destinataires
emailTitle	String	Oui	Titre de l'email
emailContent	String	Oui	Contenu HTML/text de l'email
clientAuth	String	Oui	Identifiant client pour l'authentification

Exemples de requêtes

Exemple cURL

curl -X POST "https://sendapi.afhunt.com/api/messages/email" \
  -H "Authorization: Bearer VOTRE_TOKEN_JWT" \
  -H "TokenKey: VOTRE_CLE_SECRETE" \
  -H "Content-Type: application/json" \
  -d '{
    "sender": {
      "username": "Service Client",
      "email": "contact@votreentreprise.com"
    },
    "recipients": [
      {
        "username": "Albert",
        "email": "albert@domaine.com",
        "itemId": "1"
      },
      {
        "username": "Marie",
        "email": "marie@domaine.com",
        "itemId": "2"
      }
    ],
    "emailTitle": "Confirmation de votre commande",
    "emailContent": "Bonjour {username}, votre commande #12345 a été confirmée.",
    "emailBoostLink": "https://votre-site.com/offre-speciale",
    "userDefaultTemplate": false,
    "clientAuth": "client_123",
    "provider": "sendgrid"
  }'

Exemple PHP (Guzzle)

// Code PHP disponible prochainement
// L'espace est réservé pour votre exemple PHP

Exemple Python (Requests)

# Code Python disponible prochainement
# L'espace est réservé pour votre exemple Python

Exemple Java (HttpClient)

// Code Java disponible prochainement
// L'espace est réservé pour votre exemple Java

POST

/messages/sms

Envoyer un nouveau message par SMS

Description

Endpoint pour envoyer des SMS à un ou plusieurs destinataires. Supporte les opérateurs mobiles et les extensions internationales.

Paramètres de la requête

Paramètre	Type	Obligatoire	Description
sender.telephone	String	Oui	Numéro de téléphone de l'expéditeur
recipients[].telephone	String	Oui	Numéro de téléphone du destinataire
recipients[].operateur	String	Non	Opérateur mobile (Orange, MTN, etc.)
smsContent	String	Oui	Contenu du SMS (max 160 caractères)

Exemples de requêtes

Exemple cURL

curl -X POST "https://sendapi.afhunt.com/api/messages/sms" \
  -H "Authorization: Bearer VOTRE_TOKEN_JWT" \
  -H "TokenKey: VOTRE_CLE_SECRETE" \
  -H "Content-Type: application/json" \
  -d '{
    "sender": {
      "username": "Service Client",
      "telephone": "+237612345678",
      "extension": "cm"
    },
    "recipients": [
      {
        "username": "Albert",
        "extension": "cm",
        "telephone": "689546852",
        "operateur": "Orange",
        "itemId": "1"
      }
    ],
    "smsContent": "Bonjour Albert, votre commande est prête. Suivez votre livraison ici:",
    "smsBoostLink": "https://votre-site.com/suivi/12345",
    "clientAuth": "client_123"
  }'

Exemple PHP

// Code PHP disponible prochainement

Exemple Python

# Code Python disponible prochainement

Exemple Java

// Code Java disponible prochainement

POST

/messages/whatsapp

Envoyer un nouveau message par WhatsApp

Description

Endpoint pour envoyer des messages WhatsApp à un ou plusieurs destinataires. Supporte les messages multimédias et les templates WhatsApp Business.

Paramètres de la requête

Paramètre	Type	Obligatoire	Description
whatsappContent	String	Oui	Contenu du message WhatsApp
whatsappBoostLink	String	Non	URL à inclure dans le message
recipients[].itemId	String	Oui	Identifiant unique du destinataire

Exemples de requêtes

Exemple cURL

curl -X POST "https://sendapi.afhunt.com/api/messages/whatsapp" \
  -H "Authorization: Bearer VOTRE_TOKEN_JWT" \
  -H "TokenKey: VOTRE_CLE_SECRETE" \
  -H "Content-Type: application/json" \
  -d '{
    "sender": {
      "username": "Service Client",
      "telephone": "+237612345678",
      "extension": "cm"
    },
    "recipients": [
      {
        "username": "Albert",
        "extension": "cm",
        "telephone": "689546852",
        "operateur": "Orange",
        "itemId": "1"
      }
    ],
    "whatsappContent": "Bonjour Albert! 👋 Votre commande #12345 est en cours de préparation. Nous vous tiendrons informé de son statut.",
    "whatsappBoostLink": "https://votre-site.com/whatsapp-track/12345",
    "clientAuth": "client_123"
  }'

Exemple PHP

// Code PHP disponible prochainement

Exemple Python

# Code Python disponible prochainement

Exemple Java

// Code Java disponible prochainement