مرجع API

الحملات المعتمدة

يسرد الحملات المعتمدة المملوكة للمنظمة مع تضييق اختياري بمعرّف الحملة؛ وتتطلب الخاصة اعتماد حملة مطابقًا صريحًا.

GEThttps://api.sparkglim.net/api/white-label/v1/campaigns

نموذج الوصول

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

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

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

الترويسات

الاسم	النوع	التحقق من المدخلات
`x-white-label-domain`مطلوب اسم الموقع الموثق الذي يحدد حساب المنظمة المعتمد ويربط الطلب به.	`string`	التحقق: اسم مضيف HTTPS موثّق.
`x-white-label-key`مطلوب المفتاح العام أو مفتاح الحملة الكامل ضمن نطاق القراءة الآمنة المسموح.	`string`	التحقق: مفتاح عام أو مفتاح حملة صادر بصيغة keyId:secret.

المعاملات

الاسم	النوع	التحقق من المدخلات
`campaignId`اختياري سجل حملة قائم ضمن حساب الطالب وأي نطاق أضيق لمفتاح الحملة.	`string`	التحقق: UUID ضمن نطاق المفتاح.

الطلب

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

GET /api/white-label/v1/campaigns

http

GET /api/white-label/v1/campaigns HTTP/1.1
Host: api.sparkglim.net
x-white-label-domain: events.example.com
x-white-label-key: <ISSUED_PUBLIC_OR_CAMPAIGN_KEY>

الاستجابة

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

json

{
  "success": true,
  "data": [],
  "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