كل المستندات

نظرة عامة على الواجهة

مرجع واجهة نيزا: عنوان الواجهة الأساسي والإصدارات، وواجهات الأحداث والقرارات والقوائم وWebhooks وفحص AML، ووظيفة كل واجهة.

تنزيل Markdown
الأدلةمرجع APIأمثلة الكودأفضل الممارسات

نظرة عامة على API

الأساسيات المشتركة بين جميع واجهات نيزا: البيئات، والإصدارات، والمصادقة، وصيغة الطلبات، وتقسيم النتائج إلى صفحات.

البيئات والمسارات الأساسية

Base URLs
Production:  https://api.naiza.ai
Staging:     https://staging-api.naiza.ai
Development: http://localhost:3000

جميع الواجهات الخارجية متاحة تحت /api/v1/*. احرص على أن يتوافق المفتاح مع البيئة التي تستخدمها، ولا تستخدم مفتاح الإنتاج في الاختبار.

خريطة الواجهات

الطريقةالمسارالاستخدام
POST/api/v1/decisions/evaluateتقييم المخاطر لحظيًا
POST/api/v1/eventsإرسال حدث ومعالجته فورًا (متزامن)
POST/api/v1/events/asyncوضع الحدث في طابور المعالجة
GET/api/v1/eventsالبحث في سجل الأحداث
GET/api/v1/listsقراءة قوائم السماح والحظر
POST/api/v1/feedback/decision/:idإرسال النتيجة النهائية لقرار
POST/api/v1/webhooks/subscriptionsإنشاء اشتراك Webhook
POST/api/v1/websdk/tokensإصدار رمز قصير الصلاحية للمتصفح
POST/api/v1/aml/screenفحص عميل أو كيان
POST/api/v1/aml/eventsإرسال حدث مراقبة AML

قواعد الطلب والاستجابة

  • استخدم Content-Type: application/json للطلبات والاستجابات.
  • الواجهات التي تعيد قوائم نتائج تستخدم page وlimit، وتعيد عادةً data وtotal وhasMore.
  • تقبل عوامل التصفية from وto قيمة Unix timestamp بالثواني.
  • احفظ correlationIds.requestId وcorrelationIds.eventId لربط السجلات وطلبات المتابعة.
Pagination and time filters
GET /api/v1/decisions?page=1&limit=50&from=1711833600&to=1711920000