📖 Ressources développeurs

Guide d'intégration API

Tout ce qu'il faut savoir pour intégrer FastNotify dans votre application, expliqué simplement.

1 Introduction

FastNotify est une plateforme SMS professionnelle qui permet aux développeurs d'intégrer l'envoi de messages texte dans leurs applications grâce à une API REST simple et sécurisée.

Ce guide explique, sans code complexe, comment fonctionne l'API FastNotify et les étapes à suivre pour l'intégrer dans n'importe quelle application.

💡 À qui s'adresse ce guide ?

Ce guide est destiné aux développeurs web, mobile ou backend qui souhaitent ajouter des fonctionnalités SMS dans leurs applications existantes.

Ce que vous pouvez faire avec l'API FastNotify

  • SMS personnalisés

    Envoyez des messages texte personnalisés à vos clients avec leur nom et informations.

  • Codes OTP

    Générez et envoyez des codes de vérification à usage unique pour sécuriser vos utilisateurs.

  • Notifications automatiques

    Envoyez des alertes de commande, livraison ou paiement automatiquement.

  • SMS en masse

    Envoyez des milliers de SMS personnalisés en une seule requête.

2 Comment fonctionne l'API ?

L'API FastNotify fonctionne selon le modèle REST. Imaginez l'API comme un guichet de service : votre application fait une demande, le guichet traite la demande et vous donne une réponse.

ÉtapeVotre application fait...FastNotify répond...
1Envoie une requête HTTP POST vers l'URL de l'APIReçoit la requête et vérifie votre identité
2Fournit votre clé API dans l'en-têteVérifie votre clé et votre solde SMS
3Envoie les données (numéro, message)Transmet le SMS via le réseau téléphonique
4Attend la réponse JSONRetourne le résultat avec le statut d'envoi

🔑 L'authentification par clé API

Pour utiliser l'API FastNotify, vous devez vous identifier avec une clé API unique. Cette clé joue le rôle de mot de passe pour accéder à l'API.

Où trouver votre clé API ?

Connectez-vous sur FastNotify → Cliquez sur "🔑 Ma clé API" dans le menu → Copiez votre clé.

Cette clé doit être incluse dans chaque requête dans l'en-tête (header) :

// En-tête à inclure dans chaque requête Authorization: Bearer VOTRE_CLE_API Content-Type: application/json
⚠️ Sécurité importante

Ne partagez jamais votre clé API publiquement (GitHub, forum, etc.). Si votre clé est compromise, régénérez-en une nouvelle depuis votre dashboard FastNotify.

3 Les endpoints disponibles

Un endpoint est l'adresse URL à laquelle vous envoyez vos requêtes. Chaque fonctionnalité de FastNotify a son propre endpoint.

EndpointMéthodeDescription
/api/sendsms.php POST Envoyer un SMS simple à un numéro
/api/sendotp.php POST Générer et envoyer un code OTP
/api/settings.php POST Envoyer une notification prédéfinie
/api/template.php POST Envoyer un SMS via un modèle
/api/sendbulksms.php POST Envoyer des SMS en masse
📌 URL de base

Tous les endpoints commencent par : https://fastnotify.online
Exemple complet : https://fastnotify.online/api/sendsms.php

4 Étapes d'intégration

Voici les étapes à suivre pour intégrer FastNotify dans votre application, du début à la fin.

  • Créer un compte FastNotify

    Rendez-vous sur la page d'accueil, choisissez un plan adapté à votre volume d'envoi, inscrivez-vous et effectuez le paiement via MTN MoMo ou Orange Money.

  • Récupérer votre clé API

    Connectez-vous à votre dashboard → Cliquez sur "🔑 Ma clé API" → Copiez et conservez votre clé dans un endroit sécurisé.

  • Consulter la documentation

    Depuis votre dashboard, cliquez sur "📖 Documentation API", identifiez l'endpoint dont vous avez besoin et consultez les paramètres requis.

  • Configurer votre application

    Dans votre application, configurez l'URL de base, votre clé API et l'endpoint ciblé. Stockez la clé API dans une variable d'environnement, jamais directement dans le code.

  • Envoyer votre première requête

    Envoyez une requête HTTP POST avec l'en-tête d'authentification et les données JSON (numéro, message). Vérifiez la réponse pour confirmer le succès.

  • Interpréter la réponse

    Vérifiez le champ success dans la réponse JSON. Si true → SMS envoyé. Si false → vérifiez le champ error.

// Exemple de réponse en cas de succès { "success": true, "message_id": "SM9x8a7b6c5d4e3f2a1b", "sms_restants": 487 } // Exemple de réponse en cas d'erreur { "success": false, "error": "Solde SMS insuffisant" }

5 Cas d'usage pratiques

Voici les scénarios les plus courants d'intégration de FastNotify dans une application.

🛒

Confirmation de commande

Le client valide sa commande → votre application récupère son numéro → appelle FastNotify → le client reçoit un SMS de confirmation instantanément.

🔐

Vérification OTP

L'utilisateur entre son numéro → votre app appelle /api/sendotp.php → FastNotify génère et envoie le code → l'utilisateur entre le code pour valider.

📣

SMS en masse

Préparez votre liste de clients avec leur numéro → rédigez votre message avec variables {nom} → appelez /api/sendbulksms.php → FastNotify personnalise et envoie chaque SMS.

🔔

Alertes automatiques

Créez vos modèles dans FastNotify → notez leur ID → appelez /api/template.php avec l'ID et le numéro → le message prédéfini est envoyé automatiquement.

6 Codes d'erreur courants

Lorsqu'une requête échoue, FastNotify retourne un code HTTP accompagné d'un message explicatif.

Code HTTPSignificationQue faire ?
200 ✅ Succès Le SMS a été envoyé avec succès.
400 Requête invalide Vérifiez que tous les paramètres requis sont présents et correctement formatés.
401 Non autorisé Votre clé API est manquante ou incorrecte. Vérifiez-la dans votre dashboard.
403 Solde insuffisant Votre solde SMS est épuisé. Rechargez votre compte depuis la page Facturation.
404 Endpoint introuvable L'URL de l'endpoint est incorrecte. Vérifiez la documentation API.
500 Erreur serveur Problème côté serveur. Réessayez dans quelques minutes ou contactez le support.

7 Bonnes pratiques

🔒 Sécurité

  • Ne jamais exposer la clé API publiquement
  • Stocker la clé dans une variable d'environnement
  • Régénérer la clé si compromise
  • Utiliser HTTPS pour toutes les requêtes

📊 Gestion du solde

  • Vérifier régulièrement votre solde SMS
  • Alerter quand le solde est bas
  • Gérer les erreurs 403 correctement
  • Prévoir une recharge avant épuisement

📞 Format des numéros

  • Toujours utiliser le format international
  • Cameroun : +237XXXXXXXXX
  • Valider le format avant envoi
  • Pas d'espaces ni de tirets dans le numéro

⚠️ Gestion des erreurs

  • Vérifier "success" dans chaque réponse
  • Afficher un message clair à l'utilisateur
  • Logger les erreurs d'envoi
  • Attendre 30s avant de réessayer (erreur 500)
✅ Format de numéro valide

✅ Correct : +237612345678    ❌ Incorrect : 612345678   00237612345678   +237 612 345 678

8 Support et contact

Si vous rencontrez des difficultés lors de l'intégration de l'API FastNotify, voici les ressources disponibles :

📖
Documentation en ligne Dashboard → "📖 Documentation API"
📧
Email contact@fastnotify.cm
📱
Téléphone / WhatsApp +237 672 237 297
🕐
Horaires support Lundi–Vendredi, 8h–18h (Douala)
Nous contacter → Documentation API →