Développeurs
Documentation API
Intégrez l'envoi de SMS et nos services directement dans vos applications.
Documentation en cours de finalisation : les URLs et paramètres ci-dessous illustrent le fonctionnement de l'API et vous seront confirmés à l'ouverture de votre compte.
Principe
L'API Madwan est une API REST : votre application envoie une requête HTTPS au format JSON, Madwan transmet le message aux passerelles SMS, qui l'acheminent vers les réseaux mobiles.
Votre application
API Madwan
Passerelles SMS
Réseaux mobiles
Authentification
Chaque requête contient votre clé API dans l'en-tête Authorization. Gardez cette clé côté serveur : ne l'intégrez jamais dans une application mobile ou du code JavaScript public.
Authorization: Bearer VOTRE_CLE_API
Content-Type: application/json
Envoyer un SMS
POST https://api.votredomaine.com/v1/sms/send
{
"sender": "MADWAN",
"to": ["+224XXXXXXXXX"],
"message": "Votre commande n°1024 est prête."
}
Exemple en PHP :
$ch = curl_init('https://api.votredomaine.com/v1/sms/send');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('MADWAN_API_KEY'),
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode([
'sender' => 'MADWAN',
'to' => ['+224XXXXXXXXX'],
'message' => 'Votre commande n°1024 est prête.',
]),
]);
$reponse = json_decode(curl_exec($ch), true);
Envoyer un OTP
Générez le code côté serveur, stockez-en une empreinte avec une date d'expiration courte, puis envoyez-le :
POST https://api.votredomaine.com/v1/sms/send
{
"sender": "MADWAN",
"to": ["+224XXXXXXXXX"],
"message": "Votre code de vérification est 482913. Il expire dans 5 minutes. Ne le communiquez à personne."
}
Réponses & erreurs
{
"status": "accepted",
"message_id": "msg_...",
"parts": 1
}
- 401 : clé API absente ou invalide
- 422 : paramètre manquant ou numéro invalide
- 429 : trop de requêtes, réessayez plus tard