REST API

Découvrez comment intégrer et utiliser l'API REST EngageLab SMS.

Le service EngageLab SMS propose un ensemble d'API RESTful qui vous permettent de créer des modèles et des signatures, d'envoyer des SMS et de consulter votre solde par programmation.

Suivez les étapes ci-dessous pour commencer à utiliser l'API REST.

Créer une clé API

Avant d'appeler une API EngageLab SMS, vous devez générer une clé API pour authentifier vos requêtes.

1. Connectez-vous à la console EngageLab.
2. Accédez à la sous-console SMS et sélectionnez votre application.
3. Dans la barre de navigation de gauche, accédez à API Keys.
4. Cliquez sur Create API Key pour générer un nouveau couple dev_key et dev_secret.

⚠️ Avertissement
Votre dev_secret est hautement sensible. Veillez à le conserver en lieu sûr et ne le divulguez jamais dans du code côté client ni dans des dépôts de code publics.

Authentification

L'API EngageLab SMS utilise l'authentification HTTP Basic. Vous devez inclure l'en-tête Authorization dans toutes les requêtes API.

Cet en-tête est construit en encodant en Base64 vos dev_key et dev_secret :

              
              Authorization: Basic ${base64_auth_string}

            

${base64_auth_string} est généré en joignant vos dev_key et dev_secret par un deux-points (:), puis en encodant le résultat en Base64 : base64(dev_key:dev_secret).

Pour plus de détails, consultez le guide Authentification.

Appeler l'API

Une fois votre clé API obtenue et le mécanisme d'authentification compris, vous pouvez commencer à appeler les API. Tous les points de terminaison utilisent l'URL de base https://smsapi.engagelab.com.

Voici plusieurs API principales que vous pouvez intégrer :

• Envoyer un SMS : envoyez des SMS vers un ou plusieurs numéros de mobile cibles, avec la prise en charge de l'envoi automatisé de notifications et de SMS marketing.
• Consulter le solde : consultez en temps réel le solde disponible de votre compte EngageLab SMS via l'API, y compris le solde ordinaire et le solde offert.
• Gestion des modèles : créez, modifiez, supprimez, récupérez la liste de tous les modèles et consultez les détails d'un modèle par programmation.
• Gestion des signatures : créez, modifiez, supprimez, récupérez la liste de toutes les signatures et consultez les détails d'une signature par programmation.
• Référence des événements de callback : configurez l'adresse de callback et utilisez un mécanisme de vérification sécurisé pour recevoir les rapports d'état et les notifications.
• SMPP : utilisez le protocole SMPP via une connexion TCP pour un envoi de messages et une remontée d'états efficaces et fiables.