الانتقال إلى المحتوى الرئيسي
POST
curl
الملاحظة سياق وليست قراراً، فهي لا تغيّر أبداً status أو score أو التنبيهات الخاصة بالمعاملة. يرى المراجعون الملاحظة ضمن ملاحظات في تفاصيل المعاملة في Console، ويُضاف إلى activities الخاصة بالمعاملة إدخال من نوع TRANSACTION_NOTE_ADDED، ويمكنك قراءته عبر الحصول على المعاملة. بما أن الملاحظة صادرة عن مفتاح API، فلا تحمل اسم كاتب: تكون قيمتا actor_email وactor_name هما null. إذا احتجت إلى إظهار من كتبها، فأدرج ذلك في نص الملاحظة. واقرأ السجل الزمني الكامل عبر عرض ملاحظات المعاملة.

التفويضات

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.

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

transaction_id
string<uuid>
مطلوب

معرّف UUID لمعاملة Didit: وهو uuid الذي تُرجعه POST /v3/transactions/ وGET /v3/transactions/. لا يُقبل txn_id الخاص بك.

الجسم

application/json
note
string
مطلوب

ملاحظة كنص عادي. يتم اقتطاع المسافات البيضاء في البداية والنهاية، ويتم رفض الملاحظة الفارغة. لا يوجد حد للطول.

Minimum string length: 1
mentioned_emails
string<email>[]

عناوين البريد الإلكتروني لأعضاء مؤسستك المراد الإشارة إليهم. يجب أن يكون كل منها بريداً إلكترونياً صالحاً لعضو في المؤسسة.

الاستجابة

تم إنشاء الملاحظة.

ملاحظة واحدة في الجدول الزمني لمراجعة المعاملة الخاضعة للمراقبة.

uuid
string<uuid>
مطلوب

معرّف الملاحظة.

note
string
مطلوب

متن الملاحظة النصية العادية.

actor_email
string<email> | null
مطلوب

البريد الإلكتروني لمستخدم Console الذي كتب الملاحظة أو غيّر الحالة. يكون null للملاحظات التي تم إنشاؤها باستخدام مفتاح API والملاحظات التي يضيفها Didit تلقائياً.

actor_name
string | null
مطلوب

اسم العرض لمستخدم Console (بريده الإلكتروني إذا لم يكن لديه اسم). ويكون Rule Engine في الملاحظات التي تضيفها Didit تلقائياً. وnull للملاحظات التي تم إنشاؤها باستخدام مفتاح API.

metadata
object
مطلوب

يميّز بين أنواع الملاحظات. تتضمن الملاحظات المكتوبة عبر API أو لوحة التحكم الحقل mentioned_emails. ويتضمن تغيير الحالة الذي يتم في لوحة التحكم الحقل type: status_change مع previous_status وnew_status وreason_code وreason_label. أما الملاحظات التي تضيفها Didit فتتضمن source: القيمة rule_action (مع rule_uuid) لإجراء add_note الخاص بقاعدة، أو remediation_session لمشكلة حدثت أثناء إنشاء جلسة تحقق من إجراء المستخدم.

created_at
string<date-time>
مطلوب

متى تم تخزين الملاحظة.

آخر تعديل في ٧ نوفمبر ٢٠٢٦