Logo Site EngageLab Mark Colored TransparentDocumentation
Rechercher

API OTP pour Agents IA

Tout ce dont votre agent IA a besoin pour envoyer et vérifier les OTPs — soyez opérationnel en quelques minutes.

L'API EngageLab OTP permet à votre agent IA d'envoyer et de vérifier les mots de passe à usage unique (OTP) via une API multicanal unifiée : SMS, WhatsApp, Email et Vocal. Par programmation, sans aucune interaction humaine.

Prérequis : Créer une API Key et un Modèle

Deux étapes de configuration uniques sont requises avant que votre agent puisse envoyer des OTPs — les deux doivent être complétées par un humain dans la console EngageLab.

1. Créer une API Key
Inscrivez-vous pour un compte EngageLab et créez une API Key dans la console OTP. Cela vous donne un dev_key et un dev_secret, que votre agent utilise pour authentifier toutes les requêtes API.

2. Créer et approuver un Modèle
Chaque message OTP est envoyé en utilisant un modèle pré-approuvé. Créez un modèle dans la console, configurez vos canaux d'envoi (SMS, WhatsApp, Email ou Vocal), la longueur du code et la période de validité. Les modèles passent par un processus d'examen avant de pouvoir être utilisés. Une fois approuvé, passez le Template ID à votre agent comme paramètre.

Agent Skills — Comment installer les Agent Skills EngageLab OTP ?

Les Agent Skills donnent à Cursor, Claude Code et Windsurf la connaissance pour gérer les OTPs automatiquement : envoi de codes, vérification, traitement des webhooks.

Une commande à installer, puis demandez simplement à votre agent :

# Skill for sending OTPs npx skills add https://github.com/DevEngageLab/engagelab-skills/tree/main/engagelab-otp/skills/engagelab-otp-send # Skill for verifying OTPs npx skills add https://github.com/DevEngageLab/engagelab-skills/tree/main/engagelab-otp/skills/engagelab-otp-verify # Skill for configuring and handling webhooks/callbacks npx skills add https://github.com/DevEngageLab/engagelab-skills/tree/main/engagelab-otp/skills/engagelab-otp-webhook
              
              # Skill for sending OTPs
npx skills add https://github.com/DevEngageLab/engagelab-skills/tree/main/engagelab-otp/skills/engagelab-otp-send

# Skill for verifying OTPs
npx skills add https://github.com/DevEngageLab/engagelab-skills/tree/main/engagelab-otp/skills/engagelab-otp-verify

# Skill for configuring and handling webhooks/callbacks
npx skills add https://github.com/DevEngageLab/engagelab-skills/tree/main/engagelab-otp/skills/engagelab-otp-webhook

            
Afficher ce bloc de code dans la fenêtre flottante

Voir plus de détails sur la façon d'utiliser les compétences EngageLab OTP avec vos agents IA : → Agent Skills

Docs pour Agents — Quels formats mon agent peut-il lire ?

Donnez à votre agent un accès direct à la Référence API complète. Chaque page couvre un Endpoint unique avec des paramètres de requête, des formats de réponse et des codes d'erreur complets — tout ce dont un agent a besoin pour appeler l'API EngageLab OTP sans contexte supplémentaire :

Démarrage Rapide — Envoyez et Vérifiez votre Premier OTP

Copiez les exemples de code ci-dessous dans Cursor ou Claude Code pour configurer automatiquement l'intégration OTP :

Node.js

const { OTPClient } = require('engagelab-otp'); const otp = new OTPClient( process.env.ENGAGELAB_DEV_KEY, process.env.ENGAGELAB_DEV_SECRET ); // Platform-generated OTP — the simplest way const { message_id } = await otp.send('+6591234567', 'your-template-id', {}, 'en'); const { verified } = await otp.verify(message_id, userTypedCode);
              
              const { OTPClient } = require('engagelab-otp');

const otp = new OTPClient(
  process.env.ENGAGELAB_DEV_KEY,
  process.env.ENGAGELAB_DEV_SECRET
);

// Platform-generated OTP — the simplest way
const { message_id } = await otp.send('+6591234567', 'your-template-id', {}, 'en');
const { verified }   = await otp.verify(message_id, userTypedCode);

            
Afficher ce bloc de code dans la fenêtre flottante

Python

import os from engagelab_otp import OTPClient otp = OTPClient( os.environ["ENGAGELAB_DEV_KEY"], os.environ["ENGAGELAB_DEV_SECRET"], ) # Platform-generated OTP — the simplest way result = otp.send("+6591234567", "your-template-id", {"name": "Alice"}, language="en") check = otp.verify(result["message_id"], user_typed_code) if check["verified"]: print("Success!")
              
              import os
from engagelab_otp import OTPClient

otp = OTPClient(
    os.environ["ENGAGELAB_DEV_KEY"],
    os.environ["ENGAGELAB_DEV_SECRET"],
)

# Platform-generated OTP — the simplest way
result = otp.send("+6591234567", "your-template-id", {"name": "Alice"}, language="en")
check  = otp.verify(result["message_id"], user_typed_code)
if check["verified"]:
    print("Success!")

            
Afficher ce bloc de code dans la fenêtre flottante

EngageLab fournit deux Endpoints principaux pour les flux de travail OTP :

Action Endpoint Cas d'Utilisation
Send OTP POST /v1/messages Générer et livrer un code de vérification à un utilisateur.
Verify OTP POST /v1/verifications Vérifier le code soumis par l'utilisateur.

Étapes que votre agent suivra

  1. Détecter la langue du projet à partir des fichiers de configuration (package.json, requirements.txt, etc.)
  2. Installer le SDKnpm install engagelab-otp ou pip install engagelab-otp
  3. Implémenter l'Authentification — Auth de base HTTP en utilisant base64(dev_key:dev_secret)
  4. Implémenter les Webhooks — Pour la production, configurez des endpoints de rappel pour suivre l'état de la livraison

Pour les codes d'erreur complets, référez-vous à la Référence de l'API pour chaque Endpoint (par exemple, Erreurs Envoyer OTP).

Nouveau sur EngageLab OTP ? Suivez le guide de configuration de la console étape par étape pour vous inscrire, créer un modèle et obtenir votre API Key avant d'exécuter le code ci-dessus.

SDKs Officiels — Node.js & Python

EngageLab est un fournisseur mondial d'API OTP offrant des SDKs officiels pour Node.js et Python pour vous aider à intégrer la livraison OTP, la vérification et les rappels webhook sans aucune dépendance.

Voir les instructions d'installation et les exemples pour les SDKs Node.js et Python : → SDKs

FAQ (Foire Aux Questions)

Comment un agent IA envoie-t-il un OTP sans interaction humaine ?

L'API OTP EngageLab est entièrement programmable, votre agent appelle /v1/messages pour envoyer et /v1/verifications pour vérifier. Aucune interface utilisateur, aucune étape manuelle requise.

Que se passe-t-il lorsqu'un OTP expire et que l'agent réessaie ?

Appeler à nouveau l'API d'envoi avec le même destinataire émet un nouveau code et renvoie un nouveau message_id. Le code expiré est automatiquement invalidé. → Erreurs Send OTP · Erreurs Verify OTP

Comment puis-je suivre le statut de la livraison et de la vérification OTP en temps réel ?

EngageLab OTP prend en charge les rappels webhooks — configurez une URL de rappel dans la console et le système transmettra les données d'événement à votre Endpoint lorsque des événements clés se produiront, comme le message livré, l'OTP vérifié ou les alertes de solde faible. Aucun sondage requis. → Voir la Configuration des Rappels

Comment envoyer un OTP avec Cursor ou Windsurf ?

Les compétences EngageLab OTP Agent donnent à Cursor, Windsurf et Claude Code le contexte dont ils ont besoin pour envoyer et vérifier les OTP sans quitter votre éditeur. Installez la compétence avec une seule commande :

npx skills add https://github.com/DevEngageLab/engagelab-skills/tree/main/engagelab-otp/skills/engagelab-otp-send
              
              npx skills add https://github.com/DevEngageLab/engagelab-skills/tree/main/engagelab-otp/skills/engagelab-otp-send

            
Afficher ce bloc de code dans la fenêtre flottante

Une fois installé, votre agent peut appeler l'API EngageLab OTP (POST /v1/messages) pour envoyer un mot de passe à usage unique par SMS, WhatsApp, e-mail ou vocal — et le vérifier avec POST /v1/verifications. Aucune configuration d'API manuelle n'est requise.

Icon Solid Transparent White Qiyu
Contactez-nous