التوثيق

مرجع API

الاستعلام عن صورة مرجعية

GET/v1/image-assets/{asset_id}

الحساب والمفتاح نفسيهما؛ تُرجع الموارد المنتهية الصلاحية 410، ويُرجع الحذف أثناء وجود مرجع من مهمة غير مكتملة 409.

المصادقة والصلاحيات

استخدم مفتاح GloopAPI الحالي. تعتمد النماذج والإمكانات والصلاحيات المتاحة على دليله ووثائق نقطة النهاية.

Authorization: Bearer $GLOOP_API_KEY

آليات المصادقة: BearerAuth

الطلب

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

  • asset_idstringمطلوب

    معرّف أصل صورة ia_ رُفع باستخدام المفتاح نفسه.

الاستجابات والأخطاء

HTTP 200

تم الاستعلام عن الصورة المرجعية بنجاح

application/json

النوع
object
الحقول المطلوبة
idmime_typesize_byteswidthheightexpires_at
  • file_idstringاختياري

    المعرّف العام لملف مُدار للحساب والمفتاح نفسيهما.

  • idstringمطلوب

    المعرّف العام لهذا الكائن، المستخدم لمسار تفاصيله المقابل.

  • mime_typestringمطلوب

    نوع MIME المتحقق منه للملف.

  • size_bytesintegerمطلوب

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

  • widthintegerمطلوب

    عرض الصورة بالبكسل.

  • heightintegerمطلوب

    ارتفاع الصورة بالبكسل.

  • expires_atintegerمطلوب

    ثواني Unix؛ تعني 0 عدم وجود انتهاء ثابت. يرتبط الرفع بملف مستضاف؛ تتطلب القراءة الحساب نفسه وKey نفسه.

HTTP 400

حقول الطلب أو معاملاته غير صالحة.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 401

Key مفقود أو غير صالح أو منتهي أو ملغى.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 403

صلاحيات IP أو الحساب أو النموذج أو الأداة غير كافية.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 404

الكائن/الإمكانية غير متاحين، أو مفتاح الميزة معطّل.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 409

تعارض في منع التكرار/عرض السعر، أو كائن غير جاهز، أو ما يزال مشارًا إليه.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 410

انتهت صلاحية الصورة المرجعية أو حُذفت (asset_expired).

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 429

حد معدل الطلبات/قائمة الانتظار.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 500

فشل داخلي في المصادقة أو تخزين البيانات.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 503

الخدمة أو التسعير أو التخزين غير متاح.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)