الانتقال إلى المحتوى الرئيسي
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.

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

session_id
string<uuid>
مطلوب

معرّف UUID لجلسة التحقق من المستخدمين (KYC). يجب أن تنتمي إلى التطبيق نفسه الخاص بمفتاح API — تُرجع معرّفات UUID من تطبيقات أخرى والجلسات المحذوفة ومعرّفات جلسات التحقق من الشركات (KYB) الرمز 404.

مثال:

"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d"

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

limit
integer
افتراضي:50

حجم الصفحة. القيمة الافتراضية 50.

مثال:

50

offset
integer
افتراضي:0

عدد الإدخالات المراد تخطيها من بداية الخلاصة (المرتبة). القيمة الافتراضية هي 0. يحتوي رابطا next / previous في الاستجابة على القيم الصحيحة للتنقل في الخلاصة.

مثال:

0

ordering
string
افتراضي:-created_at

ترتيب الفرز. يعتمد الموجز افتراضياً الأحدث أولاً (-created_at)؛ قم بتمرير created_at لقراءته من الأقدم أولاً. يتم تجاهل القيم غير المعروفة دون إشعار (يُستخدم الترتيب الافتراضي)؛ كما تُقبل أسماء حقول serializer الأخرى أيضاً.

مثال:

"created_at"

الاستجابة

موجز نشاط مقسم إلى صفحات، الأحدث أولاً بشكل افتراضي. count هو إجمالي عدد المدخلات؛ وnext / previous هما رابطا URL جاهزان للصفحات (null عند الأطراف). تعني قيمة count البالغة 0 مع results فارغة أنه لم يُسجَّل أي نشاط بعد.

count
integer

العدد الإجمالي لإدخالات الخلاصة لهذه الجلسة (عبر جميع الصفحات).

مثال:

3

next
string | null

رابط URL للصفحة التالية، أو null في الصفحة الأخيرة.

مثال:

null

previous
string | null

رابط URL للصفحة السابقة، أو null في الصفحة الأولى.

مثال:

null

results
object[]

إدخالات الموجز لهذه الصفحة.

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