مرجع API

طلب بائع أو متطوع أو شريك

يحفظ طلب بائع أو متطوع أو شريك بعد فحص الوحدة والحملة والتواصل مع عدم التكرار؛ ولا يوافق عليه الإرسال.

POSThttps://api.sparkglim.net/api/white-label/v1/submissions

نموذج الوصول

نموذج الوصول: توقيع المنظمة HMAC من الخادم
الصلاحية المطلوبة: submissions: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 كاملة واختيارية ومقيّدة بالنطاق.
`X-Idempotency-Key`مطلوب هوية ثابتة للعملية تعاد في المحاولات بنفس التفاصيل؛ ويرفض تغيير التفاصيل تحت المفتاح نفسه.	`string`	التحقق: 16–128 [A-Za-z0-9_-].

الطلب

الاسم	النوع	التحقق من المدخلات
`type`مطلوب نوع مورد أو تفاعل أو تصفية حملة يدعمه هذا المسار.	`enum`	التحقق: volunteer \| vendor \| partner.
`campaignId`مطلوب سجل حملة قائم ضمن حساب الطالب وأي نطاق أضيق لمفتاح الحملة.	`string`	التحقق: UUID.
`details`مطلوب كائن صارم لمعلومات المتقدم؛ لا تقبل إلا الحقول الموثقة.	`object`	التحقق: الحقول المسموح بها فقط، دون حقول إضافية.
`details.fullName`مطلوب هوية المتقدم أو المساحة المطلوبة المحفوظة مع طلب البائع أو المتطوع أو الشريك.	`string`	التحقق: 2–120.
`details.email`مطلوب بريد تواصل يستخدمه المسار المهيأ؛ ولا يمنح وحده صلاحية الوصول.	`string`	التحقق: عنوان بريد إلكتروني <=254.
`details.phone`مطلوب هاتف تواصل العضو أو المتقدم المستخدم في المسار القائم.	`string`	التحقق: رقم هاتف صالح <=40.
`details.description`مطلوب وصف يقدمه المنظم لشرح الحملة أو نوع التذكرة.	`string`	التحقق: 10–3000.
`details.businessName`اختياري هوية المتقدم أو المساحة المطلوبة المحفوظة مع طلب البائع أو المتطوع أو الشريك.	`string`	التحقق: <=160؛ مطلوب للدور vendor/partner.
`details.category`اختياري فئة الحملة المهيأة أو فئة إعدادات معتمدة حسب المورد.	`string`	التحقق: <=120؛ مطلوب للدور volunteer.
`details.stand`اختياري هوية المتقدم أو المساحة المطلوبة المحفوظة مع طلب البائع أو المتطوع أو الشريك.	`string`	التحقق: <=80.
`clientIp`اختياري عنوان IP الأصلي المقدم من خادم مصرح لاستخدامه في ضوابط الإساءة القائمة.	`string`	التحقق: عنوان IP صالح.

الطلب

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

POST /api/white-label/v1/submissions

http

POST /api/white-label/v1/submissions 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>
X-Idempotency-Key: example_stable_operation_0001
Content-Type: application/json

{
  "type": "volunteer",
  "campaignId": "11111111-1111-4111-8111-111111111111",
  "details": {
    "fullName": "Example applicant",
    "email": "applicant@example.com",
    "phone": "+233200000000",
    "description": "Example application description.",
    "category": "Example configured category"
  }
}

الاستجابة

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

json

{
  "success": true,
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "status": "pending",
    "created_at": "2030-01-01T00:00:00.000Z"
  },
  "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

نموذج الوصول

الترويسات

الطلب

الطلب

الاستجابة

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

توافق المصدر

تابع التطوير