REST API

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

Le service EngageLab OTP propose un ensemble d'API RESTful qui vous permettent de créer des modèles, d'envoyer des OTP et de vérifier des codes de vérification de manière programmatique.

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

Créer une API Key

Avant d'appeler une quelconque API EngageLab OTP, vous devez générer une API Key afin d'authentifier vos requêtes.

1. Connectez-vous à la console EngageLab.
2. Accédez à la sous-console OTP et sélectionnez votre application.
3. Dans la barre de navigation de gauche, rendez-vous dans 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 publics.

Authentification

L'API EngageLab OTP 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 encodant en Base64 vos dev_key et dev_secret reliés par deux-points (:) : base64(dev_key:dev_secret).

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

Appeler l'API

Une fois que vous disposez de votre API Key et que vous comprenez le mécanisme d'authentification, vous pouvez commencer à appeler les API. Tous les points de terminaison d'API utilisent l'URL de base https://otp.api.engagelab.cc.

Voici quelques-unes des principales API que vous pouvez intégrer :

• Envoi de code de vérification : génère un code de vérification via la plateforme EngageLab et l'envoie selon la stratégie de votre modèle.
• Vérification de code de vérification : vérifie de manière sécurisée le mot de passe à usage unique (code de vérification) soumis par l'utilisateur.
• Envoi de code de vérification personnalisé : si vous préférez générer vous-même le code de vérification, vous pouvez envoyer à l'utilisateur un code prégénéré.
• Envoi de message personnalisé : envoie un contenu de message créé à partir d'un modèle personnalisé (par exemple des notifications ou des messages marketing).
• Gestion des modèles : crée, supprime, récupère la liste de tous les modèles et consulte les détails d'un modèle de manière programmatique.
• Configuration des callbacks : configure l'adresse de callback et utilise un mécanisme de vérification sécurisé pour recevoir les rapports d'état et les notifications.
• Callback d'état du cycle de vie : reçoit en temps réel, via callback, les données relatives aux différents états du cycle de vie d'un message (envoi, remise, vérification, etc.).
• SMPP : assure un envoi de messages et un retour d'état efficaces et fiables via une connexion TCP en utilisant le protocole SMPP.