كل المستندات

واجهة الأحداث

أرسل أحداث المنتج واستعلم عنها لتقييم المخاطر.

واجهة الأحداث

إرسال متزامن أو غير متزامن، ثم قراءة السجل والإحصاءات باستخدام مفتاح API.

الطريقةالمسارالاستخدام
POST/api/v1/eventsإرسال متزامن يعيد القرار والدرجة
POST/api/v1/events/asyncقبول الحدث في الطابور وإعادة jobId
GET/api/v1/eventsقائمة الأحداث مع المرشحات والترقيم
GET/api/v1/events/:idتفاصيل حدث واحد
GET/api/v1/events/statsعدادات مجمعة للأحداث والقرارات
الحقلالنوعمطلوبالوصف
eventNamestringنعماسم ثابت يصف الفعل مثل user.login
eventCategoryenumنعممثل AUTHENTICATION أو TRANSACTION
customerobjectموصى بهالمعرف الخارجي والبريد والبيانات الوصفية
deviceobjectلامعرف الجهاز والبصمة
sessionIdstringموصى بهيربط النشاط داخل زيارة واحدة
metadataobjectلاالمبلغ والعملة وسمات المنتج
custom_fieldsobjectلاحقول أعمال مخصصة بعمق وحجم محدودين
POST /api/v1/events
curl -X POST https://api.naiza.ai/api/v1/events \
  -H "x-api-key: naiza_api_sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "eventName": "payment.completed",
    "eventCategory": "TRANSACTION",
    "customer": { "externalId": "user_123456" },
    "device": { "externalId": "device_abc123" },
    "sessionId": "session_xyz789",
    "metadata": { "amount": 250, "currency": "SAR" }
  }'
الاستجابة المتزامنة
{
  "eventId": "evt_ckm9876543210",
  "decision": "ALLOW",
  "score": 15,
  "rulesEvaluated": 5,
  "receivedAt": "2026-04-16T10:30:00.000Z",
  "processingTimeMs": 42.5
}

الإرسال غير المتزامن والبحث

يعيد المسار غير المتزامن 202 Accepted مع jobId. لمعالجة النتائج استخدم Webhook أو استعلامًا مضبوطًا.

تدعم القائمة مرشحات eventName وeventCategory وdecision وcustomer وdevice وcountry وfrom/to وsortBy/sortOrder.

تعيد الإحصاءات قيمًا مثل totalEvents وblockedEvents وeventsUnderReview وuniqueCustomers.