المرجع · الملفات

عرض ملف

GET /v1/files/{uid}

تعرض ملفًا حسب uid الخاص به، مع حجمه ودقته وعنوان الملف الأصلي وقوائم التشغيل التي يرد فيها.

معامل المسار

الاسم	النوع	الوصف
`uid`	`string`	uid الملف.

حقول الاستجابة

uid string: معرّف الملف.
name string: اسم الملف في لوحة التحكم.
type string: نوع الملف، مثل image أو video.
duration integer: المدة بالثواني.
archived boolean: true إذا كان الملف مؤرشفًا.
organization object: مؤسسة الملف: uid وname.
size integer: حجم الملف الأصلي بالبايت.
width integer: عرض الملف الأصلي بالبكسل.
height integer: ارتفاع الملف الأصلي بالبكسل.
aspect_ratio string: النسبة بين العرض والارتفاع، مثل 1.78.
url string: عنوان الملف الأصلي، أو نص فارغ إذا لم يكن متاحًا.
scheduled boolean: true إذا كانت للملف جدولة نشطة.
playlists array: قوائم التشغيل التي يرد فيها الملف (uid وname وorganization). لا تظهر إلا قوائم التشغيل التي يمكن للمستخدم رؤيتها.

الأخطاء المحتملة

404 not_found نقطة النهاية غير موجودة، أو أن العنصر غير موجود أو يتبع مؤسسة لا يمكن للمستخدم رؤيتها.
تنطبق أخطاء المفتاح وحد الطلبات على جميع نقاط النهاية. عرض جميع الأخطاء

الطلبcURLPHPJavaScript

curl "https://api.on-cloud.live/v1/files/a87ff679a2f3e71d9181a67b7542122c" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/files/a87ff679a2f3e71d9181a67b7542122c');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('API_KEY')],
]);
$response = json_decode(curl_exec($ch), true);

const res = await fetch('https://api.on-cloud.live/v1/files/a87ff679a2f3e71d9181a67b7542122c', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

الاستجابة200

{
  "data": {
    "uid": "a87ff679a2f3e71d9181a67b7542122c",
    "name": "Promoção de verão",
    "type": "video",
    "duration": 30,
    "archived": false,
    "organization": {
      "uid": "8f14e45fceea167a5a36dedd4bea2543",
      "name": "Loja Centro"
    },
    "size": 18734520,
    "width": 1920,
    "height": 1080,
    "aspect_ratio": "1.78",
    "url": "https://oncloud.bunny.files.on-cloud.live/files/a87ff679a2f3e71d9181a67b7542122c-1.mp4",
    "scheduled": true,
    "playlists": [
      {
        "uid": "e4da3b7fbbce2345d7772b0674a318d5",
        "name": "Lista principal",
        "organization": {
          "uid": "8f14e45fceea167a5a36dedd4bea2543",
          "name": "Loja Centro"
        }
      }
    ]
  }
}

عنصر غير موجود أو بلا صلاحية وصول404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}