Guide de Démarrage

Bienvenue dans la documentation de l’API REST Mon SMS PRO. Ce guide vous aidera à configurer et utiliser notre API pour envoyer des SMS.

Prérequis

• Un compte Mon SMS PRO
• Une clé API valide
• Un environnement de développement
• Un client HTTP (cURL, Postman, etc.)

Installation

Notre API REST ne nécessite pas d’installation de package. Vous pouvez l’utiliser directement avec n’importe quel client HTTP.

Configuration de l’environnement

# URL de base de l'API
BASE_URL="https://rest.monsms.pro"
 
# Votre clé API
YOUR_API_KEY="your_api_key_here"

Authentification

Toutes les requêtes à l’API nécessitent une clé API valide. Incluez votre clé API dans le corps de chaque requête.

POST /v1/any-endpoint
Content-Type: application/json
 
{
  "apiKey": "YOUR_API_KEY",
  // autres paramètres...
}

Premier message

Voici un exemple simple pour envoyer votre premier SMS :

POST /v1/campaign/create
Content-Type: application/json
 
{
  "apiKey": "YOUR_API_KEY",
  "contacts": [
    {
      "phone": "22500000000"
    }
  ],
  "text": "Bonjour ! Ceci est mon premier message via l'API REST Mon SMS PRO.",
  "type": "SMS"
}

Structure des réponses

Toutes les réponses de l’API suivent le même format :

{
  "success": boolean,
  "data": any,
  "error": any
}

Codes de statut HTTP

• 200 : Succès
• 200 : Requête invalide
• 200 : Non authentifié
• 200 : Non autorisé
• 200 : Ressource non trouvée
• 200 : Trop de requêtes
• 200 : Erreur serveur

Bonnes pratiques

1. Sécurité : Protégez votre clé API
2. Gestion des erreurs : Implémentez une gestion robuste des erreurs
3. Rate limiting : Respectez les limites de requêtes
4. Validation : Validez les données avant l’envoi
5. Logging : Gardez une trace des requêtes
6. Monitoring : Surveillez les performances
7. Backup : Ayez un plan de secours
8. Documentation : Documentez votre implémentation

Exemples d’utilisation

Envoi d’un SMS simple

curl -X POST https://rest.monsms.pro/v1/campaign/create \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "YOUR_API_KEY",
    "contacts": [
      {
        "phone": "22500000000"
      }
    ],
    "text": "Bonjour !",
    "type": "SMS"
  }'

Création d’un contact

curl -X POST https://rest.monsms.pro/v1/contact/create \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "YOUR_API_KEY",
    "phone": "22500000000",
  }'

Création d’un groupe

curl -X POST https://rest.monsms.pro/v1/group/create \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "YOUR_API_KEY",
    "name": "Mes Contacts",
    "description": "Groupe de contacts principaux",
    "contacts": [
      {
        "phone": "22500000000"
      }
      {
        "phone": "22500000001"
      }
    ]
  }'

FAQ

Comment obtenir une clé API ?

Connectez-vous à votre compte Mon SMS PRO et accédez à la section API pour générer une clé.

Quelles sont les limites de l’API ?

Les limites dépendent de votre forfait. Contactez-nous pour plus d’informations.

Comment gérer les erreurs ?

Vérifiez le code de statut HTTP et le message d’erreur dans la réponse.

Puis-je tester l’API ?

Oui, nous fournissons un environnement de test. Contactez-nous pour obtenir les accès.

Comment suivre mes messages ?

Utilisez l’endpoint /v1/campaign/list pour suivre vos campagnes.

Comment mettre à jour ma clé API ?

Vous pouvez générer une nouvelle clé API à tout moment depuis votre compte.

Référence API Interactive