انتقل إلى المحتوى
Sursa Developers

POST/v1/uploads/{upload_id}/complete

إكمال عملية رفع

complete_upload

عند استلام كل الأجزاء، يجمّع Sursa الملف، ويقارن SHA-256 للملف كله بالحقل sha256 في نص الطلب، ويجري الفحوص نفسها التي يجريها للرفع في طلب واحد: الصيغة حسب توقيع المحتوى والفحص بمضاد الفيروسات. النتيجة هي ready، أو rejected مع reject_reason (checksum_mismatch، type_mismatch، unsupported_format، infected، scan_unavailable، unsafe_content). يُسجَّل كل رفض بسبب فحص الصيغة أو مضاد الفيروسات في سجل التدقيق بوصفه file.rejected.

الاستجابة 200 تعني أن النتيجة جاهزة؛ و202 تعني أن الملف لا يزال قيد الفحص (processing)، وتأتي النتيجة من GET /v1/uploads/{upload_id}. إذا عادت الحالة إلى pending (أوقفت إعادة تشغيل أحد مثيلات API الفحص)، أرسل complete مرة أخرى. تكرار complete بعد النتيجة يعيد النتيجة نفسها. الأجزاء الناقصة تعيد 409 uploads.incomplete (details.missing). قيمة sha256 المختلفة عن المعلنة عند الإنشاء، أو قيمة parts[].etag المختلفة عن جزء مستلم، تعيد 422 uploads.checksum_mismatch. عملية الرفع الجاهزة غير المستخدمة تبقى 24 ساعة. أُضيف في الإصدار 1.62.0.

المصادقة

أرسل مفتاح API في الترويسة Authorization: Authorization: Bearer <key>.

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

  • upload_idstringمطلوب

    معرّف عملية الرفع (upl_ يليه 32 حرفًا ست عشريًا).

    length ≤ 64

معاملات الترويسة

  • Idempotency-Keystring

    مفتاح لإعادة محاولة عملية كتابة بأمان: من 1 إلى 255 حرفًا من أحرف ASCII القابلة للطباعة؛ يُنصح بقيمة UUID v4 لكل عملية منطقية. إعادة المحاولة بالمفتاح نفسه خلال 24 ساعة لا تنفّذ العملية مرة أخرى، بل تعيد الاستجابة المحفوظة (الحالة والترويسات والنص) مع الترويسة Idempotency-Replayed: true. المفتاح نفسه مع أسلوب أو مسار أو Content-Type أو نص مختلف يعيد 409 api.idempotency_mismatch؛ وما دام الطلب الأول قيد التنفيذ، يعيد 409 api.idempotency_in_progress مع Retry-After: 1. بعد استجابة 5xx أو 429 يُحرَّر المفتاح، وتنفّذ إعادة المحاولة العملية مرة أخرى. نطاق المفتاح هو المؤسسة والجهة المستدعية (مفتاح API أو مستخدم أو مفتاح مصدر مخصص).

    length ≥ 1, length ≤ 255

نص الطلب

application/json

الكائن: UploadComplete

  • sha256stringمطلوب

    قيمة SHA-256 للملف كاملًا.

  • partsarray of UploadPartRef

    فحص اختياري للأجزاء: قيمة ETag لكل جزء كما أعادتها PUT …/parts/{n}.

    items ≤ 1000

الاستجابات

200النتيجة جاهزة: `ready` أو `rejected`.

ترويسات الاستجابة

  • RateLimit-Policy

    الحدود السارية، بصيغة مسودة IETF draft-ietf-httpapi-ratelimit-headers: عناصر مفصولة بفواصل "<name>";q=<quota>;w=<window in seconds>. العنصر key هو معدل طلبات مفتاح API (الحصة هي هامش الذروة، والنافذة الزمنية هي مدة إعادة ملئه بالكامل؛ وللجلسة يكون user، ودون بيانات اعتماد ip)؛ وminute وday وmonth هي حصص المؤسسة للدقيقة واليوم والشهر التقويمية بتوقيت UTC.

  • RateLimit

    المتبقي من كل حد في الترويسة RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    حد العنصر الأشد صرامة في الترويسة RateLimit-Policy (العنصر الذي بقي فيه أقل عدد من الطلبات).

  • X-RateLimit-Remaining

    عدد الطلبات المتبقية ضمن الحد الأشد صرامة.

  • X-RateLimit-Reset

    عدد الثواني حتى إعادة ضبط الحد الأشد صرامة.

  • Idempotency-Replayed

    القيمة true: أُعيدت الاستجابة المحفوظة لهذا المفتاح Idempotency-Key، ولم تُنفَّذ العملية مرة أخرى.

application/json

الكائن: Upload

  • idstringمطلوب

    معرّف عملية الرفع (upl_ يليه 32 حرفًا ست عشريًا).

  • purposeUploadPurposeمطلوب
  • filenamestringمطلوب

    اسم الملف (بلا مجلدات).

  • content_typestringمطلوب

    نوع المحتوى المعلن؛ فارغ إن لم يُعلَن.

  • sizeinteger (int64)مطلوب

    حجم الملف بالبايت.

  • sha256string | nullمطلوب

    قيمة SHA-256 للملف، المعلنة عند الإنشاء أو في الخطوة complete؛ والقيمة null إن لم تكن معروفة بعد.

  • statusUploadStatusمطلوب
  • part_sizeinteger (int64)مطلوب

    حجم كل جزء عدا الأخير (من 5 إلى 100 ميبيبايت).

  • part_countintegerمطلوب

    عدد الأجزاء.

    ≥ 1, ≤ 1000

  • parts_receivedintegerمطلوب

    عدد الأجزاء المستلمة.

    ≥ 0

  • partsarray of UploadPartمطلوب

    الأجزاء المستلمة حسب الرقم (فارغ في استجابة POST /v1/uploads).

  • reject_reasonstring | nullمطلوب

    سبب الرفض (rejected): checksum_mismatch، وtype_mismatch، وunsupported_format، وinfected، وscan_unavailable، وunsafe_content. قد يتوسع التعداد؛ والقيمة null إن لم تُرفض عملية الرفع.

  • reject_detailsobject | nullمطلوب

    تفاصيل الرفض (الامتداد، والصيغة المعلنة والمكتشفة، والمجاميع الاختبارية)؛ والقيمة null إن لم تُرفض عملية الرفع.

  • created_atstring (date-time)مطلوب

    وقت إنشاء عملية الرفع.

  • expires_atstring (date-time)مطلوب

    الموعد النهائي لإكمال عملية الرفع، ثم لاستخدامها بعد أن تصبح جاهزة.

  • completed_atstring (date-time) | nullمطلوب

    وقت انتهاء الفحص (ready أو rejected).

  • consumed_atstring (date-time) | nullمطلوب

    وقت استخدام عملية الرفع (لبطاقة أو أرشيف أو استيراد).

202الملف لا يزال قيد الفحص (`processing`).

ترويسات الاستجابة

  • RateLimit-Policy

    الحدود السارية، بصيغة مسودة IETF draft-ietf-httpapi-ratelimit-headers: عناصر مفصولة بفواصل "<name>";q=<quota>;w=<window in seconds>. العنصر key هو معدل طلبات مفتاح API (الحصة هي هامش الذروة، والنافذة الزمنية هي مدة إعادة ملئه بالكامل؛ وللجلسة يكون user، ودون بيانات اعتماد ip)؛ وminute وday وmonth هي حصص المؤسسة للدقيقة واليوم والشهر التقويمية بتوقيت UTC.

  • RateLimit

    المتبقي من كل حد في الترويسة RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    حد العنصر الأشد صرامة في الترويسة RateLimit-Policy (العنصر الذي بقي فيه أقل عدد من الطلبات).

  • X-RateLimit-Remaining

    عدد الطلبات المتبقية ضمن الحد الأشد صرامة.

  • X-RateLimit-Reset

    عدد الثواني حتى إعادة ضبط الحد الأشد صرامة.

  • Idempotency-Replayed

    القيمة true: أُعيدت الاستجابة المحفوظة لهذا المفتاح Idempotency-Key، ولم تُنفَّذ العملية مرة أخرى.

application/json

الكائن: Upload

  • idstringمطلوب

    معرّف عملية الرفع (upl_ يليه 32 حرفًا ست عشريًا).

  • purposeUploadPurposeمطلوب
  • filenamestringمطلوب

    اسم الملف (بلا مجلدات).

  • content_typestringمطلوب

    نوع المحتوى المعلن؛ فارغ إن لم يُعلَن.

  • sizeinteger (int64)مطلوب

    حجم الملف بالبايت.

  • sha256string | nullمطلوب

    قيمة SHA-256 للملف، المعلنة عند الإنشاء أو في الخطوة complete؛ والقيمة null إن لم تكن معروفة بعد.

  • statusUploadStatusمطلوب
  • part_sizeinteger (int64)مطلوب

    حجم كل جزء عدا الأخير (من 5 إلى 100 ميبيبايت).

  • part_countintegerمطلوب

    عدد الأجزاء.

    ≥ 1, ≤ 1000

  • parts_receivedintegerمطلوب

    عدد الأجزاء المستلمة.

    ≥ 0

  • partsarray of UploadPartمطلوب

    الأجزاء المستلمة حسب الرقم (فارغ في استجابة POST /v1/uploads).

  • reject_reasonstring | nullمطلوب

    سبب الرفض (rejected): checksum_mismatch، وtype_mismatch، وunsupported_format، وinfected، وscan_unavailable، وunsafe_content. قد يتوسع التعداد؛ والقيمة null إن لم تُرفض عملية الرفع.

  • reject_detailsobject | nullمطلوب

    تفاصيل الرفض (الامتداد، والصيغة المعلنة والمكتشفة، والمجاميع الاختبارية)؛ والقيمة null إن لم تُرفض عملية الرفع.

  • created_atstring (date-time)مطلوب

    وقت إنشاء عملية الرفع.

  • expires_atstring (date-time)مطلوب

    الموعد النهائي لإكمال عملية الرفع، ثم لاستخدامها بعد أن تصبح جاهزة.

  • completed_atstring (date-time) | nullمطلوب

    وقت انتهاء الفحص (ready أو rejected).

  • consumed_atstring (date-time) | nullمطلوب

    وقت استخدام عملية الرفع (لبطاقة أو أرشيف أو استيراد).

401لم تُرسَل بيانات اعتماد (لا ملف تعريف ارتباط للجلسة ولا مفتاح API)، أو لم يُعثر على المفتاح.

ترويسات الاستجابة

  • RateLimit-Policy

    الحدود السارية، بصيغة مسودة IETF draft-ietf-httpapi-ratelimit-headers: عناصر مفصولة بفواصل "<name>";q=<quota>;w=<window in seconds>. العنصر key هو معدل طلبات مفتاح API (الحصة هي هامش الذروة، والنافذة الزمنية هي مدة إعادة ملئه بالكامل؛ وللجلسة يكون user، ودون بيانات اعتماد ip)؛ وminute وday وmonth هي حصص المؤسسة للدقيقة واليوم والشهر التقويمية بتوقيت UTC.

  • RateLimit

    المتبقي من كل حد في الترويسة RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    حد العنصر الأشد صرامة في الترويسة RateLimit-Policy (العنصر الذي بقي فيه أقل عدد من الطلبات).

  • X-RateLimit-Remaining

    عدد الطلبات المتبقية ضمن الحد الأشد صرامة.

  • X-RateLimit-Reset

    عدد الثواني حتى إعادة ضبط الحد الأشد صرامة.

application/json

الكائن: Error

403الإجراء غير مسموح: الدور غير كافٍ، أو لا وصول إلى المجموعة أو البطاقة، أو يعمل الطلب في وضع «View as»، أو المؤسسة معلّقة أو محذوفة (الحقل `detail` كائن فيه `code: org_suspended | org_deleted`).

ترويسات الاستجابة

  • RateLimit-Policy

    الحدود السارية، بصيغة مسودة IETF draft-ietf-httpapi-ratelimit-headers: عناصر مفصولة بفواصل "<name>";q=<quota>;w=<window in seconds>. العنصر key هو معدل طلبات مفتاح API (الحصة هي هامش الذروة، والنافذة الزمنية هي مدة إعادة ملئه بالكامل؛ وللجلسة يكون user، ودون بيانات اعتماد ip)؛ وminute وday وmonth هي حصص المؤسسة للدقيقة واليوم والشهر التقويمية بتوقيت UTC.

  • RateLimit

    المتبقي من كل حد في الترويسة RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    حد العنصر الأشد صرامة في الترويسة RateLimit-Policy (العنصر الذي بقي فيه أقل عدد من الطلبات).

  • X-RateLimit-Remaining

    عدد الطلبات المتبقية ضمن الحد الأشد صرامة.

  • X-RateLimit-Reset

    عدد الثواني حتى إعادة ضبط الحد الأشد صرامة.

application/json

الكائن: Error

404الكائن غير موجود أو غير متاح لك. لا تؤكد واجهة API وجود كائن مقيّد الوصول.

ترويسات الاستجابة

  • RateLimit-Policy

    الحدود السارية، بصيغة مسودة IETF draft-ietf-httpapi-ratelimit-headers: عناصر مفصولة بفواصل "<name>";q=<quota>;w=<window in seconds>. العنصر key هو معدل طلبات مفتاح API (الحصة هي هامش الذروة، والنافذة الزمنية هي مدة إعادة ملئه بالكامل؛ وللجلسة يكون user، ودون بيانات اعتماد ip)؛ وminute وday وmonth هي حصص المؤسسة للدقيقة واليوم والشهر التقويمية بتوقيت UTC.

  • RateLimit

    المتبقي من كل حد في الترويسة RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    حد العنصر الأشد صرامة في الترويسة RateLimit-Policy (العنصر الذي بقي فيه أقل عدد من الطلبات).

  • X-RateLimit-Remaining

    عدد الطلبات المتبقية ضمن الحد الأشد صرامة.

  • X-RateLimit-Reset

    عدد الثواني حتى إعادة ضبط الحد الأشد صرامة.

application/json

الكائن: Error

409حالة الكائن لا تسمح بالإجراء، مثل التكرار، أو فهرسة جارية، أو مهمة معالجة عولجت بالفعل.

ترويسات الاستجابة

  • RateLimit-Policy

    الحدود السارية، بصيغة مسودة IETF draft-ietf-httpapi-ratelimit-headers: عناصر مفصولة بفواصل "<name>";q=<quota>;w=<window in seconds>. العنصر key هو معدل طلبات مفتاح API (الحصة هي هامش الذروة، والنافذة الزمنية هي مدة إعادة ملئه بالكامل؛ وللجلسة يكون user، ودون بيانات اعتماد ip)؛ وminute وday وmonth هي حصص المؤسسة للدقيقة واليوم والشهر التقويمية بتوقيت UTC.

  • RateLimit

    المتبقي من كل حد في الترويسة RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    حد العنصر الأشد صرامة في الترويسة RateLimit-Policy (العنصر الذي بقي فيه أقل عدد من الطلبات).

  • X-RateLimit-Remaining

    عدد الطلبات المتبقية ضمن الحد الأشد صرامة.

  • X-RateLimit-Reset

    عدد الثواني حتى إعادة ضبط الحد الأشد صرامة.

application/json

الكائن: Error

410كان الكائن موجودًا لكنه لم يعد متاحًا: استُخدم الرابط أو انتهت صلاحيته، أو حُذف الملف في نهاية مدة الاحتفاظ به.

ترويسات الاستجابة

  • RateLimit-Policy

    الحدود السارية، بصيغة مسودة IETF draft-ietf-httpapi-ratelimit-headers: عناصر مفصولة بفواصل "<name>";q=<quota>;w=<window in seconds>. العنصر key هو معدل طلبات مفتاح API (الحصة هي هامش الذروة، والنافذة الزمنية هي مدة إعادة ملئه بالكامل؛ وللجلسة يكون user، ودون بيانات اعتماد ip)؛ وminute وday وmonth هي حصص المؤسسة للدقيقة واليوم والشهر التقويمية بتوقيت UTC.

  • RateLimit

    المتبقي من كل حد في الترويسة RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    حد العنصر الأشد صرامة في الترويسة RateLimit-Policy (العنصر الذي بقي فيه أقل عدد من الطلبات).

  • X-RateLimit-Remaining

    عدد الطلبات المتبقية ضمن الحد الأشد صرامة.

  • X-RateLimit-Reset

    عدد الثواني حتى إعادة ضبط الحد الأشد صرامة.

application/json

الكائن: Error

422خطأ في صحة البيانات: نص الطلب أو المعاملات لا تطابق المخطط (الحقل `detail` قائمة بأخطاء صحة البيانات)، أو قيمة معامل خارج النطاق المسموح (الحقل `detail` رسالة نصية).

ترويسات الاستجابة

  • RateLimit-Policy

    الحدود السارية، بصيغة مسودة IETF draft-ietf-httpapi-ratelimit-headers: عناصر مفصولة بفواصل "<name>";q=<quota>;w=<window in seconds>. العنصر key هو معدل طلبات مفتاح API (الحصة هي هامش الذروة، والنافذة الزمنية هي مدة إعادة ملئه بالكامل؛ وللجلسة يكون user، ودون بيانات اعتماد ip)؛ وminute وday وmonth هي حصص المؤسسة للدقيقة واليوم والشهر التقويمية بتوقيت UTC.

  • RateLimit

    المتبقي من كل حد في الترويسة RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    حد العنصر الأشد صرامة في الترويسة RateLimit-Policy (العنصر الذي بقي فيه أقل عدد من الطلبات).

  • X-RateLimit-Remaining

    عدد الطلبات المتبقية ضمن الحد الأشد صرامة.

  • X-RateLimit-Reset

    عدد الثواني حتى إعادة ضبط الحد الأشد صرامة.

application/json

الكائن: Error

429طلبات كثيرة جدًا (`api.rate_limited`)، أو استُنفدت حصة المؤسسة للدقيقة أو اليوم أو الشهر (`api.quota_exceeded`؛ يحتوي الحقل `error.details` على `quota` و`limit` و`reset_at`)، أو بلغت المؤسسة حدها، أو خدمة الإجابات مشغولة (`answers.engine_busy`). انتظر المدة المذكورة في الترويسة `Retry-After`.

ترويسات الاستجابة

  • Retry-After

    عدد الثواني التي تنتظرها قبل إعادة محاولة الطلب.

  • RateLimit-Policy

    الحدود السارية، بصيغة مسودة IETF draft-ietf-httpapi-ratelimit-headers: عناصر مفصولة بفواصل "<name>";q=<quota>;w=<window in seconds>. العنصر key هو معدل طلبات مفتاح API (الحصة هي هامش الذروة، والنافذة الزمنية هي مدة إعادة ملئه بالكامل؛ وللجلسة يكون user، ودون بيانات اعتماد ip)؛ وminute وday وmonth هي حصص المؤسسة للدقيقة واليوم والشهر التقويمية بتوقيت UTC.

  • RateLimit

    المتبقي من كل حد في الترويسة RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    حد العنصر الأشد صرامة في الترويسة RateLimit-Policy (العنصر الذي بقي فيه أقل عدد من الطلبات).

  • X-RateLimit-Remaining

    عدد الطلبات المتبقية ضمن الحد الأشد صرامة.

  • X-RateLimit-Reset

    عدد الثواني حتى إعادة ضبط الحد الأشد صرامة.

application/json

الكائن: Error

رموز الأخطاء

الرموز التي قد تعيدها نقطة النهاية هذه في error.code، إضافةً إلى الرموز العامة لكل طلب.

إعادة المحاولة بأمان

أرسل الترويسة Idempotency-Key (قيمة UUID مثلًا) مع كل طلب POST وPATCH. إعادة المحاولة بالمفتاح نفسه خلال 24 ساعة تعيد الاستجابة المحفوظة بدل تنفيذ الطلب مرة أخرى.

حدود المعدل

تحمل الاستجابات الترويستين RateLimit وRateLimit-Policy، والترويسات الأقدم X-RateLimit-Limit وX-RateLimit-Remaining وX-RateLimit-Reset. وفي الاستجابة 429 الترويسة Retry-After بالثواني: انتظر ثم أعد المحاولة.

← uploads · مرجع API