Première vérification
1. Prérequis
Pour utiliser EngageLab OTP afin de générer, d’envoyer et de vérifier des mots de passe à usage unique, les développeurs doivent effectuer les préparatifs suivants avant de commencer :
1.1 Configurer un modèle
Suivez les instructions de Créer un modèle OTP pour configurer le nom du modèle, l’ID du modèle, le nom de la marque, la longueur du mot de passe à usage unique, la durée d’expiration et les autres informations requises pour l’envoi des messages EngageLab OTP.
1.2 Créer une clé API
Lorsque vous utilisez l’API EngageLab OTP pour générer ou vérifier des mots de passe à usage unique, vous devez créer une clé d’authentification API de base. Vous pouvez suivre les instructions de Créer une clé API OTP.
2. Effectuer un envoi
Vous pouvez choisir l’une des deux méthodes suivantes pour envoyer votre premier message de vérification EngageLab OTP :
2.1 Envoyer depuis la console du site web
- 2.1.1 Générer et envoyer un code de vérification
Connectez-vous à la console du site web EngageLab, accédez à [API Debugging] -> [OTP Send], puis saisissez dans l’ordre, sur la page, la created API key, le target mobile number or email address, l’template ID et la template language :
Après avoir saisi les informations ci-dessus, cliquez sur Send OTP Request pour générer un code de vérification et l’envoyer au target mobile number or email address spécifié.
Si la requête réussit, vous pouvez voir le canal de réponse utilisé pour l’envoi ainsi que le message_id dans la zone Response ci-dessous :
Si la requête échoue, vous pouvez voir le code d’erreur spécifique et le message d’erreur dans la zone Response ci-dessous :
Une fois le message envoyé avec succès, cliquez sur les détails du message dans l’historique pour afficher le one-time password généré et le message_id.
- 2.1.2 Vérifier le code de vérification
Connectez-vous à la console du site web EngageLab, accédez à [API Debugging] -> [OTP Verification], puis saisissez dans l’ordre, sur la page, la created API key, le message_id et le one-time password généré. Après avoir rempli le formulaire, cliquez sur le bouton Verify OTP Request :
2.2 Intégration API
Intégrez l’API EngageLab OTP dans votre code. Pour plus de détails, reportez-vous aux deux documents suivants :
3. Afficher l’historique
Après un envoi réussi, vous pouvez afficher sur la page Historique des informations telles que le nom du modèle, l’heure d’envoi, le destinataire, le statut du message et le coût estimé. Pour plus de détails, reportez-vous à : Historique EngageLab OTP
