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

عرض قائمة الملفات

تعرض ملفات المؤسسات التي يمكن للمستخدم فيها رؤية الملفات، من الأحدث إلى الأقدم.

استجابة مقسّمة إلى صفحات: تأتي العناصر في data ومعلومات الصفحة في meta. ترقيم الصفحات والتصفية

المعاملات

حقول كل عنصر

uid string

معرّف الملف.

name string

اسم الملف في لوحة التحكم.

type string

نوع الملف، مثل image أو video.

duration integer

المدة بالثواني.

archived boolean

true إذا كان الملف مؤرشفًا.

organization object

مؤسسة الملف: uid وname.

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

• 400 invalid_parameter أحد المعاملات له قيمة غير صالحة، مثل per_page بقيمة أكبر من الحد الأقصى.
• 404 organization_not_found قيمة organization المحددة لا تخص مؤسسة يمكن للمستخدم فيها رؤية هذا النوع من العناصر.
• تنطبق أخطاء المفتاح وحد الطلبات على جميع نقاط النهاية. عرض جميع الأخطاء

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

<?php
$ch = curl_init('https://api.on-cloud.live/v1/files?per_page=2');
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?per_page=2', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data, meta } = await res.json();

{
  "data": [
    {
      "uid": "c20ad4d76fe97759aa27a0c99bff6710",
      "name": "Horário de funcionamento",
      "type": "image",
      "duration": 8,
      "archived": false,
      "organization": {
        "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
        "name": "Loja Shopping Norte"
      }
    },
    {
      "uid": "6512bd43d9caa6e02c990b0a82652dca",
      "name": "Cardápio do dia",
      "type": "image",
      "duration": 10,
      "archived": false,
      "organization": {
        "uid": "8f14e45fceea167a5a36dedd4bea2543",
        "name": "Loja Centro"
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 2,
    "total": 3,
    "total_pages": 2
  }
}