Developer documentation

{
  "success": true,
  "status": "queued",
  "logId": "uuid",
  "channel": "email",
  "langUsed": "fr",
  "langFallback": false,
  "testMode": false,
  "project": "Overlook",
  "context": {
    "project": { "id": "uuid", "name": "Overlook", "slug": "overlook", "teamId": "uuid" },
    "apiKey": { "mode": "live", "prefix": "znd_live_", "suffix": "ejho" },
    "plan": {
      "slug": "free",
      "name": "Free",
      "status": "active",
      "emailApiEnabled": false,
      "whatsappEnabled": true,
      "emailQuota": 25000,
      "emailsUsed": 0
    },
    "channels": { "email": true, "whatsapp": false }
  }
}

my-otp-app/                 ← any stack (Python, .NET, PHP, Node…)
├── .cursor/
│   └── mcp.json            ← ONLY file required for Cursor MCP
├── .env                    ← ZINDUA_API_KEY for YOUR app SDK (server-side)
├── .gitignore
└── … your app code …

# Any HTTP client

export ZINDUA_API_KEY="znd_live_xxxxxxxxxxxxxxxxxxxx"

# https://zindua.run/api/v1/send
# Authorization: Bearer znd_live_xxx

curl -X POST https://zindua.run/api/v1/send \
  -H "Authorization: Bearer $ZINDUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "user@example.com",
    "channel": "email",
    "template": "welcome",
    "variables": { "name": "Alex" }
  }'

curl -X POST https://zindua.run/api/v1/send \
  -H "Authorization: Bearer $ZINDUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+243812345678",
    "channel": "whatsapp",
    "template": "otp-verification",
    "variables": { "code": "4592" }
  }'

curl -X POST https://zindua.run/api/v1/send \
  -H "Authorization: Bearer $ZINDUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+243812345678",
    "channel": "whatsapp",
    "template": "otp-verification",
    "lang": "fr",
    "variables": { "code": "4592" }
  }'

npm install @zindua/sdk

# .env.local — one key per Zindua project (server only)
ZINDUA_KEY_MELLIA=znd_live_xxxxxxxxxxxxxxxxxxxxxxxx
ZINDUA_KEY_OVERLOOK=znd_live_yyyyyyyyyyyyyyyyyyyyyyyy

// lib/zindua.ts
import { Zindua } from '@zindua/sdk';

export const zinduaByTenant = {
  mellia: new Zindua({ apiKey: process.env.ZINDUA_KEY_MELLIA! }),
  overlook: new Zindua({ apiKey: process.env.ZINDUA_KEY_OVERLOOK! }),
};

// Pick tenant → project key (mellia | overlook)
await zinduaByTenant.mellia.send({
  to: 'user@example.com',
  template: 'welcome',
  variables: { name: 'Alex' },
});

await zinduaByTenant.overlook.send({
  to: '+243812345678',
  channel: 'whatsapp',
  template: 'otp-verification',
  variables: { code: '4592', app: 'MonApp' },
});

await zinduaByTenant.overlook.send({
  to: '+243812345678',
  channel: 'whatsapp',
  template: 'otp-verification',
  lang: 'fr',
  variables: { code: '4592' },
});

// Errors: import { ZinduaError } from '@zindua/sdk'
// catch (e) { if (e instanceof ZinduaError) console.log(e.code, e.status) }

npm install @zindua/sdk

ZINDUA_API_KEY=znd_live_xxxxxxxxxxxxxxxxxxxx

// server/zindua.ts (backend only)
import { Zindua } from '@zindua/sdk';

export const zindua = new Zindua({
  apiKey: process.env.ZINDUA_API_KEY!,
});

// pages/api/notify.ts
import { zindua } from '@/server/zindua';

export default async function handler(req, res) {
  const { email, template, variables } = req.body;
  const result = await zindua.send({ to: email, template, variables });
  res.status(202).json(result);
}

// Client calls YOUR backend, not Zindua:
await fetch('/api/notify', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    phone: '+243812345678',
    template: 'otp-verification',
    variables: { code: '482910' },
  }),
});

// Backend maps phone → Zindua send:
await zindua.send({
  to: phone,
  channel: 'whatsapp',
  template: 'otp-verification',
  lang: 'fr',
  variables: { code },
});

pip install zindua-sdk

export ZINDUA_API_KEY=znd_live_xxxxxxxxxxxxxxxxxxxx

import os
from zindua import Zindua

zindua = Zindua(api_key=os.environ["ZINDUA_API_KEY"])

result = await zindua.send(
    to="user@example.com",
    channel="email",
    template="reset-password",
    variables={"name": "Sarah", "link": "https://..."},
)
print(result.log_id, result.status)

result = await zindua.send(
    to="+243812345678",
    channel="whatsapp",
    template="otp-verification",
    variables={"code": "4592"},
)
print(result.log_id)

result = await zindua.send(
    to="+243812345678",
    channel="whatsapp",
    template="otp-verification",
    lang="fr",
    variables={"code": "4592"},
)
print(result.lang_fallback)

# pubspec.yaml
dependencies:
  http: ^1.2.0

// Pass key from your backend. Never ship znd_live_ in the app

// Call YOUR backend; it holds the Zindua API key.
// Direct Zindua calls from mobile are not recommended.

// Your backend POST https://zindua.run/api/v1/send
// Body: { "to": "customer@example.com", "template": "order-shipped", ... }

// Your backend:
// { "to": "+243812345678", "channel": "whatsapp", "template": "otp-verification", ... }

await http.post(
  Uri.parse('https://api.yourapp.com/v1/notify'),
  headers: {'Content-Type': 'application/json'},
  body: jsonEncode({
    'phone': '+243812345678',
    'template': 'otp-verification',
    'lang': 'fr',
    'code': '4592',
  }),
);

# Use your backend. No Zindua key in the app

ZINDUA_API_KEY=znd_live_... # server .env only

// Node/Express backend with @zindua/sdk or HTTP POST https://zindua.run/api/v1/send

// Backend:
await zindua.send({
  to: email,
  channel: 'email',
  template: 'verify-email',
  variables: { link },
});

await zindua.send({
  to: phone,
  channel: 'whatsapp',
  template: 'otp-verification',
  variables: { code },
});

await fetch('https://api.yourapp.com/send-otp', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ phone: '+243812345678', code, lang: 'fr' }),
});