الانتقال إلى المحتوى الرئيسي
GET
curl
اقرأ تصديرًا بدأته باستخدام تصدير الملفات.
  • PENDING وPROCESSING: يجري إعداد ملف ZIP. اقرأ التصدير مرة أخرى بعد بضع ثوانٍ.
  • READY: download_url رابط موقّع إلى ملف ZIP يبقى صالحًا لمدة قصيرة. اقرأ التصدير مرة أخرى للحصول على رابط جديد حتى expires_at.
  • FAILED: تعذّر إعداد ملف ZIP. ابدأ تصديرًا جديدًا.
  • EXPIRED: تم حذف ملف ZIP. ابدأ تصديرًا جديدًا.
يُسجَّل كل استعلام يُرجع رابط تنزيل في سجل تدقيق الجلسة. يُرجع تصدير جلسة محذوفة الرمز 404.

التفويضات

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.

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

sessionId
string<uuid>
مطلوب

معرّف UUID لجلسة التحقق (session_id الذي تم إرجاعه بواسطة POST /v3/session/). يقبل معرّفات جلسات التحقق من المستخدمين (KYC) والتحقق من الشركات (KYB). تُرجع الجلسة المحذوفة 404.

مثال:

"11111111-2222-3333-4444-555555555555"

exportId
string<uuid>
مطلوب

معرّف export_id الذي تم إرجاعه بواسطة POST /v3/session/{sessionId}/files-export/.

مثال:

"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"

الاستجابة

التصدير.

ملف ZIP واحد يحتوي على كل ملفات الجلسة، بالجودة الأصلية.

export_id
string<uuid>
مطلوب

معرّف التصدير. مرره إلى GET /v3/session/{sessionId}/files-export/{exportId}/.

session_id
string<uuid>
مطلوب

الجلسة التي تنتمي إليها الملفات.

status
enum<string>
مطلوب

PENDING وPROCESSING أثناء إعداد ملف ZIP، وREADY بمجرد أن يصبح قابلاً للتنزيل، وFAILED عندما يتعذر إعداده (اطلب عملية تصدير جديدة)، وEXPIRED بمجرد حذف ملف ZIP.

الخيارات المتاحة:
PENDING,
PROCESSING,
READY,
FAILED,
EXPIRED
file_count
integer | null
مطلوب

الملفات الموجودة في ملف ZIP. تُعيّن فقط عندما تكون status هي READY.

size_bytes
integer<int64> | null
مطلوب

حجم ملف ZIP بالبايت. يُعيَّن فقط عندما تكون status هي READY.

download_url
string<uri> | null
مطلوب

رابط URL موقّع لملف ZIP، صالح لفترة قصيرة. يُعيَّن فقط عندما تكون status هي READY؛ اقرأ التصدير مجدداً للحصول على رابط جديد.

expires_at
string<date-time> | null
مطلوب

وقت حذف ملف ZIP، بعد 24 ساعة من جاهزيته. لا يُعيَّن إلا عندما تكون status هي READY.

error
string | null
مطلوب

سبب فشل التصدير، عندما تكون قيمة status هي FAILED.

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

وقت طلب التصدير.

completed_at
string<date-time> | null
مطلوب

وقت جاهزية ملف ZIP أو فشل التصدير.

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