مرجع API

تحديث مشارك

يحدّث مشاركًا تابعًا للمنظمة فقط مع حفظ ضوابط الحملة والموافقة القائمة.

PATCHhttps://api.sparkglim.net/api/white-label/v1/participants/:participantId

نموذج الوصول

نموذج الوصول: توقيع المنظمة HMAC من الخادم
الصلاحية المطلوبة: campaigns:write
التوفر الموثّق: منفذ في المصدر

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

يبقى التوقيع الخاص في خادمك؛ تستخدم واجهة الإصدار 1 تنسيق توقيع v2 ولا تصبح واجهة إصدار 2.

الترويسات

الاسم	النوع	التحقق من المدخلات
`x-white-label-domain`مطلوب اسم الموقع الموثق الذي يحدد حساب المنظمة المعتمد ويربط الطلب به.	`string`	التحقق: اسم مضيف HTTPS موثّق.
`x-white-label-key-id`مطلوب المعرّف المستخرج من قيمة المفتاح الخاص الواحدة؛ لا ترسل السر في هذه الترويسة.	`string`	التحقق: المعرّف الداخلي للمفتاح الخاص الصادر.
`x-white-label-signature-version`مطلوب يحدد تنسيق التوقيع المرتبط بالنطاق؛ وتبقى مسارات الواجهة في الإصدار 1.	`string`	التحقق: 2.
`x-white-label-timestamp`مطلوب توقيت توقيع الطلب بالمللي ثانية؛ يقارنه الخادم بساعته لرفض الطلبات القديمة.	`string`	التحقق: توقيت بالمللي ثانية من 13 رقمًا؛ ضمن خمس دقائق.
`x-white-label-nonce`مطلوب قيمة توقيع عشوائية جديدة يسجلها الخادم لمنع إعادة تشغيل الطلب الموقّع.	`string`	التحقق: قيمة جديدة: 16–128 [A-Za-z0-9_-].
`x-white-label-signature`مطلوب توقيع HMAC-SHA256 للنطاق ومفتاح عدم التكرار واعتماد الحملة والتوقيت وnonce والطريقة والمسار والاستعلام المرتب وبصمة الجسم الدقيقة.	`string`	التحقق: HMAC-SHA256 بالنظام الست عشري وبأحرف صغيرة.
`x-white-label-campaign-key`اختياري مفتاح حملة كامل اختياري يضيّق الطلب الخاص إلى الحملة المصرح بها نفسها.	`string`	التحقق: قيمة keyId:secret كاملة واختيارية ومقيّدة بالنطاق.

المعاملات

الاسم	النوع	التحقق من المدخلات
`participantId`مطلوب المرشح المختار ضمن هذه الحملة؛ ويتحقق الخادم من الموافقة وقواعدها.	`string`	التحقق: UUID أو معرّف مورد موثّق.

الطلب

الاسم	النوع	التحقق من المدخلات
`campaignId`اختياري سجل حملة قائم ضمن حساب الطالب وأي نطاق أضيق لمفتاح الحملة.	`string`	التحقق: UUID.
`name`اختياري الاسم المعروض لنوع التذكرة أو المشارك الذي تديره العملية.	`string`	التحقق: 2–160.
`categoryId`اختياري فئة قائمة تابعة لهذه الحملة؛ ولا تقبل فئة من حساب أو حملة أخرى.	`string\|null`	التحقق: UUID.
`bio`اختياري السيرة الخاصة بالمرشح المقدمة من المنظم المصرح به.	`string\|null`	التحقق: <=5000.
`phoneNumber`اختياري هاتف المشارك؛ وقد تتطلب وسائل الدفع وقواعد الحملة رقمًا دوليًا صحيحًا.	`string\|null`	التحقق: <=32.
`imageUrl`اختياري رابط صورة المورد المقدمة؛ استخدم وسائط عامة مصرحًا بها.	`string\|null`	التحقق: URL.
`applicationStatus`اختياري حالة موافقة المرشح المقبولة في عقد إدارة المنظمة.	`enum`	التحقق: pending \| approved \| rejected.
`metadata`اختياري بيانات JSON إضافية يقبلها المخطط؛ ولا تتجاوز التفويض أو الأسعار أو الملكية.	`object`	التحقق: كائن JSON.

الطلب

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

PATCH /api/white-label/v1/participants/:participantId

http

PATCH /api/white-label/v1/participants/11111111-1111-4111-8111-111111111111 HTTP/1.1
Host: api.sparkglim.net
x-white-label-domain: events.example.com
x-white-label-key-id: <ISSUED_KEY_ID>
x-white-label-signature-version: 2
x-white-label-timestamp: <FRESH_MILLISECONDS>
x-white-label-nonce: <FRESH_SIGNING_NONCE>
x-white-label-signature: <SERVER_GENERATED_SIGNATURE>
Content-Type: application/json

{
  "bio": "Example biography"
}

الاستجابة

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

json

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

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

json

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

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

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

للمنظمات: 120 طلبًا لكل مفتاح و300 لكل IP في النافذة؛ التزم بـ Retry-After وترويسات X-RateLimit.

توافق المصدر

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

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

نموذج الوصول

الترويسات

المعاملات

الطلب

الطلب

الاستجابة

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

توافق المصدر

تابع التطوير