SDK
Offizielle EngageLab OTP Node.js- und Python-SDKs.
EngageLab stellt offizielle Node.js- und Python-SDKs bereit, die Ihnen helfen, OTP-Zustellung, -Verifizierung und Webhook-Callback-Funktionen ohne Abhängigkeiten zu integrieren.
Node.js SDK
Das offizielle Node.js SDK unterstützt Node.js 14+ und enthält TypeScript-Deklarationen.
Installation
npm install engagelab-otp
npm install engagelab-otp
Diesen Codeblock im schwebenden Fenster anzeigen
Schnellstart
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);
Diesen Codeblock im schwebenden Fenster anzeigen
Webhook-Callback (Express)
EngageLab signiert Callbacks mit X-CALLBACK-ID (HMAC-SHA256). Das SDK überprüft die Signatur und parst die Ereignisse für Sie.
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; // In transit (e.g., retrying) — wait
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; // In transit (e.g., retrying) — wait
if (e.status === 'delivered') await markDelivered(e.message_id);
else if (e.status === 'verified') await markVerified(e.message_id);
}
}));
Diesen Codeblock im schwebenden Fenster anzeigen
Weitere Beispiele, einschließlich des Versands benutzerdefinierter OTP-Codes und der Fehlerbehandlung, finden Sie unter engagelab-otp auf npm oder im Github-Repository.
Python SDK
Das offizielle Python SDK unterstützt Python 3.8+ und hat keine externen Abhängigkeiten.
Installation
pip install engagelab-otp
pip install engagelab-otp
Diesen Codeblock im schwebenden Fenster anzeigen
Schnellstart
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!")
Diesen Codeblock im schwebenden Fenster anzeigen
Webhook-Callback (Flask)
Das SDK stellt einen WebhookVerifier bereit, der automatisch die HMAC-SHA256-Signatur überprüft und die Ereignis-Payload parst.
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 # In transit, wait
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 # In transit, wait
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"],
)
Diesen Codeblock im schwebenden Fenster anzeigen
Weitere Beispiele, einschließlich des Versands benutzerdefinierter OTP-Codes und der Fehlerbehandlung, finden Sie unter engagelab-otp auf PyPI oder im Github-Repository.
