الانتقال إلى المحتوى الرئيسي
GET
curl
يُنشأ التقرير عند الطلب من البيانات الحالية للمعاملة، لذا أعد استدعاءه بعد تغيير الحالة للحصول على نسخة محدّثة. وعلى خلاف endpoints المعاملات الأخرى، يقع هذا المسار ضمن نطاق التطبيق، لذا ضع معرّف مؤسستك ومعرّف التطبيق الذي ينتمي إليه مفتاح API في عنوان URL. راجع البحث عن معرّف مؤسستك.
يُعدّ تقرير PDF من الوسائط. يحتاج مفتاح API المقيّد النطاق إلى media: read بالإضافة إلى transactions: read، ويحصل المفتاح الذي لا يملك صلاحية الوصول إلى الوسائط على 403 حتى لو كان قادرًا على قراءة المعاملة بصيغة JSON باستخدام الحصول على المعاملة.

التفويضات

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.

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

organization_id
string<uuid>
مطلوب

UUID الخاص بالمؤسسة.

application_id
string<uuid>
مطلوب

معرّف UUID للتطبيق. يجب أن يكون التطبيق الذي ينتمي إليه مفتاح API: أي مفتاح يُستخدم مع تطبيق آخر يتلقى الرمز 403.

transaction_uuid
string<uuid>
مطلوب

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

الاستجابة

ملف PDF المُصيَّر، يتم إرجاعه مباشرة كملف ثنائي application/pdf.

The response is of type file.

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