SDK
SDK officiels EngageLab OTP pour Node.js et Python.
EngageLab fournit des SDK officiels pour Node.js et Python afin de vous aider à intégrer l'envoi d'OTP, la vérification et les callbacks Webhook sans aucune dépendance.
SDK Node.js
Le SDK officiel Node.js prend en charge Node.js 14+ et inclut des déclarations TypeScript.
Installation
npm install engagelab-otp
npm install engagelab-otp
Afficher ce bloc de code dans la fenêtre flottante
Démarrage rapide
const { OTPClient } = require('engagelab-otp');
const otp = new OTPClient(
process.env.ENGAGELAB_DEV_KEY,
process.env.ENGAGELAB_DEV_SECRET
);
// OTP généré par la plateforme — la méthode la plus simple
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
);
// OTP généré par la plateforme — la méthode la plus simple
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
Callback Webhook (Express)
EngageLab signe les callbacks à l'aide de X-CALLBACK-ID (HMAC-SHA256). Le SDK vérifie la signature et analyse les événements à votre place.
const express = require('express');
const { WebhookVerifier } = require('engagelab-otp');
const app = express();
app.use(express.json());
const verifier = new WebhookVerifier({
username: process.env.ENGAGELAB_WEBHOOK_USERNAME,
secret: process.env.ENGAGELAB_WEBHOOK_SECRET,
});
app.post('/webhook', verifier.middleware(async (events) => {
for (const e of events) {
if (e.kind !== 'message_status') continue;
if (!e.is_terminal) continue; // En cours de transmission (par exemple, renvoi en cours) — attendre
if (e.status === 'delivered') await markDelivered(e.message_id);
else if (e.status === 'verified') await markVerified(e.message_id);
}
}));
const express = require('express');
const { WebhookVerifier } = require('engagelab-otp');
const app = express();
app.use(express.json());
const verifier = new WebhookVerifier({
username: process.env.ENGAGELAB_WEBHOOK_USERNAME,
secret: process.env.ENGAGELAB_WEBHOOK_SECRET,
});
app.post('/webhook', verifier.middleware(async (events) => {
for (const e of events) {
if (e.kind !== 'message_status') continue;
if (!e.is_terminal) continue; // En cours de transmission (par exemple, renvoi en cours) — attendre
if (e.status === 'delivered') await markDelivered(e.message_id);
else if (e.status === 'verified') await markVerified(e.message_id);
}
}));
Afficher ce bloc de code dans la fenêtre flottante
Pour plus d'exemples, notamment l'envoi de codes OTP personnalisés et la gestion des erreurs, consultez engagelab-otp sur npm ou le dépôt Github.
SDK Python
Le SDK officiel Python prend en charge Python 3.8+ et n'a aucune dépendance externe.
Installation
pip install engagelab-otp
pip install engagelab-otp
Afficher ce bloc de code dans la fenêtre flottante
Démarrage rapide
import os
from engagelab_otp import OTPClient
otp = OTPClient(
os.environ["ENGAGELAB_DEV_KEY"],
os.environ["ENGAGELAB_DEV_SECRET"],
)
# OTP généré par la plateforme — la méthode la plus simple
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"],
)
# OTP généré par la plateforme — la méthode la plus simple
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
Callback Webhook (Flask)
Le SDK fournit un WebhookVerifier qui vérifie automatiquement la signature HMAC-SHA256 et analyse la charge utile (payload) de l'événement.
import os
from flask import Flask
from engagelab_otp import WebhookVerifier, MessageStatusEvent
app = Flask(__name__)
verifier = WebhookVerifier(
username=os.environ["ENGAGELAB_WEBHOOK_USERNAME"],
secret=os.environ["ENGAGELAB_WEBHOOK_SECRET"],
)
def handle(events):
for e in events:
if not isinstance(e, MessageStatusEvent):
continue
if not e.is_terminal:
continue # En cours de transmission, attendre
if e.status == "delivered":
mark_delivered(e.message_id)
elif e.status == "verified":
mark_verified(e.message_id)
app.add_url_rule(
"/webhook",
"engagelab_webhook",
verifier.flask_view(handle),
methods=["POST"],
)
import os
from flask import Flask
from engagelab_otp import WebhookVerifier, MessageStatusEvent
app = Flask(__name__)
verifier = WebhookVerifier(
username=os.environ["ENGAGELAB_WEBHOOK_USERNAME"],
secret=os.environ["ENGAGELAB_WEBHOOK_SECRET"],
)
def handle(events):
for e in events:
if not isinstance(e, MessageStatusEvent):
continue
if not e.is_terminal:
continue # En cours de transmission, attendre
if e.status == "delivered":
mark_delivered(e.message_id)
elif e.status == "verified":
mark_verified(e.message_id)
app.add_url_rule(
"/webhook",
"engagelab_webhook",
verifier.flask_view(handle),
methods=["POST"],
)
Afficher ce bloc de code dans la fenêtre flottante
Pour plus d'exemples, notamment l'envoi de codes OTP personnalisés et la gestion des erreurs, consultez engagelab-otp sur PyPI ou le dépôt Github.
