مرجع API

حالة التذكرة العامة

يقرأ حالة الدخول العامة ضمن نطاق العميل دون تسجيل دخول الضيف أو كشف QR التذكرة المشتراة.

POSThttps://api.sparkglim.net/api/white-label/v1/tickets/verify

نموذج الوصول

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

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

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

الترويسات

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

الطلب

الاسم	النوع	التحقق من المدخلات
`campaignId`مطلوب سجل حملة قائم ضمن حساب الطالب وأي نطاق أضيق لمفتاح الحملة.	`string`	التحقق: UUID مطلوب للبحث عن التذكرة ضمن النطاق المصرح به.
`ticketCode`مطلوب اعتماد تذكرة قائم في الحملة المصرح بها للقراءة أو الدخول المصرح.	`string`	التحقق: بيانات اعتماد التذكرة؛ 3–120.

الطلب

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

POST /api/white-label/v1/tickets/verify

http

POST /api/white-label/v1/tickets/verify HTTP/1.1
Host: api.sparkglim.net
x-white-label-domain: events.example.com
x-white-label-key: <ISSUED_PUBLIC_OR_CAMPAIGN_KEY>
Content-Type: application/json

{
  "campaignId": "11111111-1111-4111-8111-111111111111",
  "ticketCode": "<EXISTING_TICKET_CODE>"
}

الاستجابة

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

json

{
  "success": true,
  "data": {
    "status": "invalid",
    "message": "This ticket code is invalid."
  },
  "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

نموذج الوصول

الترويسات

الطلب

الطلب

الاستجابة

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

توافق المصدر

تابع التطوير