مرجع API

إدراج إشعار مهيأ

يرسل بريدًا أو SMS مفعّلًا بإعدادات المرسل والمزود ويعيد سجل الإشعار ونتيجة التسليم.

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

نموذج الوصول

نموذج الوصول: توقيع المنظمة HMAC من الخادم
الصلاحية المطلوبة: notifications: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 كاملة واختيارية ومقيّدة بالنطاق.

الطلب

الاسم	النوع	التحقق من المدخلات
`channel`مطلوب قناة تسليم أو تكامل تدعمها العملية والتهيئة المفعلة للحساب.	`enum`	التحقق: email \| sms.
`eventType`مطلوب حدث إشعار أو موضوعه أو بياناته التي يقبلها مسار التسليم المفعّل للمنظمة.	`string`	التحقق: 1–120.
`recipient`مطلوب عنوان التواصل المستهدف للإشعار المسموح أو تحدي التحقق.	`string`	التحقق: 3–255.
`subject`اختياري حدث إشعار أو موضوعه أو بياناته التي يقبلها مسار التسليم المفعّل للمنظمة.	`string\|null`	التحقق: <=255.
`payload`اختياري حدث إشعار أو موضوعه أو بياناته التي يقبلها مسار التسليم المفعّل للمنظمة.	`object`	التحقق: بيانات الحدث المهيأة.

الطلب

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

POST /api/white-label/v1/notifications

http

POST /api/white-label/v1/notifications 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

{
  "channel": "email",
  "eventType": "<CONFIGURED_EVENT>",
  "recipient": "member@example.com",
  "payload": {}
}

الاستجابة

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

json

{
  "success": true,
  "data": {
    "record": {
      "id": "11111111-1111-4111-8111-111111111111"
    },
    "result": {}
  },
  "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

نموذج الوصول

الترويسات

الطلب

الطلب

الاستجابة

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

توافق المصدر

تابع التطوير