مرجع API

تحديث علاقة العضو

يحدّث علاقة الموزع ويزامن عضو فريق المنشئ المصرح والمرتبط عند وجوده.

PATCHhttps://api.sparkglim.net/api/white-label/portal/reseller/members/:memberId

نموذج الوصول

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

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

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

الترويسات

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

المعاملات

الاسم	النوع	التحقق من المدخلات
`memberId`مطلوب سجل علاقة أو مراجعة قائم ضمن الحساب؛ ويتحقق الخادم من الملكية والصلاحيات اللازمة.	`string`	التحقق: UUID أو معرّف مورد موثّق.

الطلب

الاسم	النوع	التحقق من المدخلات
`userId`اختياري ارتباط اختياري بمستخدم قائم؛ ولا تنشئ العملية حساب منشئ غير محدود.	`string\|null`	التحقق: UUID لمستخدم موجود فقط.
`creatorId`اختياري مالك فريق المنشئ المصرح به لعلاقة الموزع؛ ويستخدم مالك الموزع المهيأ افتراضيًا.	`string\|null`	التحقق: UUID لمالك مصرح له؛ القيمة الافتراضية هي منشئ الموزّع.
`memberType`اختياري دور علاقة الموزع؛ وتطبق الصلاحيات المعينة وصلاحيات الفريق بصورة منفصلة.	`enum`	التحقق: owner \| operator \| finance \| support \| sub_creator.
`status`اختياري الحالة المدعومة المطلوبة؛ وتتحكم قواعد الموافقة في النشر والوصول.	`enum`	التحقق: invited \| pending \| active \| suspended \| revoked.
`displayName`اختياري اسم عرض العضو أو المساهم؛ ولا يغيّر ملكية الحساب.	`string\|null`	التحقق: 2–160.
`email`اختياري بريد تواصل يستخدمه المسار المهيأ؛ ولا يمنح وحده صلاحية الوصول.	`string\|null`	التحقق: عنوان بريد إلكتروني.
`phone`اختياري هاتف تواصل العضو أو المتقدم المستخدم في المسار القائم.	`string\|null`	التحقق: 8–40.
`roles`اختياري أدوار الموزع المقبولة بالمخطط مع تقييد منفصل بصلاحيات الخادم.	`string[]`	التحقق: أدوار الموزّع المدعومة.
`permissions`اختياري الصلاحيات المدعومة المطلوبة، وتقيّدها سياسة الحساب وتفويض الطالب.	`string[]`	التحقق: إمكانات الموزّع المدعومة.
`otpRequired`اختياري يحدد متطلب التحقق المدعوم دون تجاوز فحوص أهلية الخادم.	`boolean`	التحقق: القيمة الافتراضية: true.
`kycStatus`اختياري حالة مراجعة علاقة الموزع؛ ولا تجيز المدفوعات وحدها.	`enum`	التحقق: not_required \| pending \| verified \| rejected.
`metadata`اختياري بيانات JSON إضافية يقبلها المخطط؛ ولا تتجاوز التفويض أو الأسعار أو الملكية.	`object`	التحقق: كائن JSON.

الطلب

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

PATCH /api/white-label/portal/reseller/members/:memberId

http

PATCH /api/white-label/portal/reseller/members/11111111-1111-4111-8111-111111111111 HTTP/1.1
Host: api.sparkglim.net
Authorization: Bearer <EXISTING_SESSION_TOKEN>
Content-Type: application/json

{
  "displayName": "Example member"
}

الاستجابة

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

json

{
  "success": true,
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "status": "pending"
  }
}

استجابة الخطأ · 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

نموذج الوصول

الترويسات

المعاملات

الطلب

الطلب

الاستجابة

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

توافق المصدر

تابع التطوير