مرجع API

طلب رمز تحقق مهيأ

يبدأ تحدي تحقق خاصًا بالحساب عبر قناة مفعلة ويسجل انتهاءه وحالة تسليمه.

POSThttps://api.sparkglim.net/api/white-label/portal/reseller/otp/send

نموذج الوصول

نموذج الوصول: جلسة SparkGlim وصلاحيات العضو
الصلاحية المطلوبة: otp:send
التوفر الموثّق: منفذ في المصدر

التوفر موثق من المصدر وليس ضمانًا لتشغيل الإنتاج.

استخدم مسار أعضاء فريق المنشئ؛ ولا تمنح إعادة البيع وصولًا غير محدود للبيانات أو الإدارة.

الترويسات

الاسم	النوع	التحقق من المدخلات
`Authorization`مطلوب جلسة SparkGlim حاملة قائمة؛ وتحدد عضوية الحساب والصلاحيات المعينة السماح بكل عملية.	`string`	التحقق: رمز Bearer لجلسة مصادقة موجودة.

الطلب

الاسم	النوع	التحقق من المدخلات
`channel`مطلوب قناة تسليم أو تكامل تدعمها العملية والتهيئة المفعلة للحساب.	`enum`	التحقق: sms \| email \| whatsapp.
`recipient`مطلوب عنوان التواصل المستهدف للإشعار المسموح أو تحدي التحقق.	`string`	التحقق: 3–255.
`purpose`مطلوب غرض تحقق مدعوم ومرتبط بالحساب الطالب وتحدي OTP.	`enum`	التحقق: login \| signup \| withdrawal_approval \| payment_method_verification \| campaign_approval.
`memberId`اختياري سجل علاقة أو مراجعة قائم ضمن الحساب؛ ويتحقق الخادم من الملكية والصلاحيات اللازمة.	`string\|null`	التحقق: UUID.
`metadata`اختياري بيانات JSON إضافية يقبلها المخطط؛ ولا تتجاوز التفويض أو الأسعار أو الملكية.	`object`	التحقق: كائن JSON.

الطلب

تصف الأمثلة العقد ولا تُنفذ. استخدم سجلات اختبار مصرحًا بها، ولا تلصق أسرارًا حقيقية في هذه الصفحات.

POST /api/white-label/portal/reseller/otp/send

http

POST /api/white-label/portal/reseller/otp/send HTTP/1.1
Host: api.sparkglim.net
Authorization: Bearer <EXISTING_SESSION_TOKEN>
Content-Type: application/json

{
  "channel": "email",
  "recipient": "member@example.com",
  "purpose": "login"
}

الاستجابة

استجابة النجاح · HTTP 201

json

{
  "success": true,
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "status": "pending",
    "expiresAt": "2030-01-01T00:10:00.000Z",
    "source": "sms_verification_codes"
  }
}

استجابة الخطأ · HTTP 400

json

{
  "success": false,
  "error": "<ERROR_MESSAGE>"
}

تستخدم أخطاء التحقق والصلاحيات والموارد والأعطال حالة HTTP وبنية الخطأ الخاصة بالمعالج.

الحدود وإعادة المحاولة

الحد الافتراضي: 100 طلب لكل عنوان IP خلال 60 ثانية، مع ضوابط إضافية حسب المورد.

توافق المصدر

تتطلب العمليات المصرح بها اختبارًا خاصًا بالحساب.

server/src/api/router.ts
server/src/api/routes/white-label.ts
server/src/white-label/reseller-service.ts
server/src/white-label/schemas.ts

نموذج الوصول

الترويسات

الطلب

الطلب

الاستجابة

الحدود وإعادة المحاولة

توافق المصدر

تابع التطوير