الانتقال إلى المحتوى الرئيسي
GET
curl

التفويضات

x-api-key
string
header
مطلوب

مفتاح API الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys.

معلمات المسار

rule_uuid
string<uuid>
مطلوب

المعرّف الفريد العالمي (uuid) للقاعدة من القائمة أو الإنشاء.

الاستجابة

القاعدة.

uuid
string<uuid>
title
string

اسم القاعدة. فريد لكل تطبيق بين القواعد غير المحذوفة؛ وترجع الأسماء المكررة الرمز 400.

description
string | null
category
string

موضوع المخاطر المستخدم للتجميع وإعداد التقارير، مثل finance، وaml_ctf، وanomaly_detection، وfatf، وdevice_intelligence، وcrypto_monitoring، وtravel_rule، وresponsible_gaming، وe_commerce.

mode
enum<string>

يقوم ACTIVE بالتقييم المباشر. يقوم TEST بالتقييم وتسجيل عمليات تشغيل القواعد ولكنه لا يؤثر أبدًا في الدرجة أو الحالة - وهو وضع البدء الموصى به. يتم تخطي DISABLED.

الخيارات المتاحة:
ACTIVE,
DISABLED,
TEST
evaluation_mode
enum<string>
افتراضي:ALL

ما إذا كان يجب أن يتطابق كل شرط (ALL) أو شرط واحد على الأقل (ANY). يتم تجاهله عندما تستخدم الشروط group_index.

الخيارات المتاحة:
ALL,
ANY
scope
object

أي معاملات تنطبق عليها القاعدة. يتم قبول هذه المفاتيح الثلاثة فقط.

conditions
object[]
aggregation
object[]
actions
object[]

إجراء قاعدة واحد. يمكن أن تحمل القاعدة عدة إجراءات؛ وتُطبّق جميعها معاً عند تطابقها. تسجل القواعد في وضع TEST ما كانت ستفعله دون تطبيق أي إجراء.

metadata
object

بيانات وصفية بصيغة حرة مخزنة في القاعدة.

severity
enum<string> | null

مستوى خطورة معلوماتي تحمله قواعد المكتبة؛ لا يمكن تعيينه في القواعد المخصصة.

الخيارات المتاحة:
UNKNOWN,
LOW,
MEDIUM,
HIGH,
CRITICAL
source
enum<string>

تأتي قواعد PRESET من المكتبة (تثبيت/إلغاء تثبيت، تعديلات على الوضع فقط)؛ أما قواعد CUSTOM فهي ملكك بالكامل.

الخيارات المتاحة:
PRESET,
CUSTOM
library_key
string | null

معرّف مكتبة ثابت؛ تكون القيمة null للقواعد المخصصة.

latest_triggered_at
string<date-time> | null
run_count
integer

عدد المعاملات التي تطابقت مع هذه القاعدة.

approved_count
integer
reviewed_count
integer
declined_count
integer
awaiting_user_count
integer
approved_pct
number
reviewed_pct
number
declined_pct
number
created_at
string<date-time>
updated_at
string<date-time>
آخر تعديل في ٧ نوفمبر ٢٠٢٦