রেফারেন্স · ফাইল

ফাইলের তালিকা

GET /v1/files

যেসব প্রতিষ্ঠানে ব্যবহারকারী ফাইল দেখতে পারেন, সেগুলোর ফাইলের তালিকা নতুন থেকে পুরোনো ক্রমে দেয়।

পেজে ভাগ করা রেসপন্স: আইটেমগুলো আসে data-তে এবং পেজের তথ্য আসে meta-তে। পেজিনেশন ও ফিল্টার

প্যারামিটার

নাম	ধরন	বিবরণ
`organization`	`string`	কোনো প্রতিষ্ঠানের uid, শুধু সেই প্রতিষ্ঠানের আইটেম আনার জন্য (দেখুন `/organizations`)।
`q`	`string`	নামের অংশ, সর্বোচ্চ 100টি অক্ষর।
`type`	`string`	ফাইলের ধরন, যেমন `image` বা `video`।
`archived`	`integer`	শুধু আর্কাইভ করা ফাইলের জন্য `1`, অথবা শুধু আর্কাইভ না করা ফাইলের জন্য `0`। এই প্যারামিটার না দিলে সব ফাইল আসে।
`page`	`integer`	পেজ, 1 থেকে শুরু। ডিফল্ট: 1।
`per_page`	`integer`	প্রতি পেজে আইটেম, 1 থেকে 100 পর্যন্ত। ডিফল্ট: 50।

প্রতিটি আইটেমের ফিল্ড

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 এমন কোনো প্রতিষ্ঠান নয়, যেখানে ব্যবহারকারী এই ধরনের আইটেম দেখতে পারেন।
কী ও সীমা-সংক্রান্ত ত্রুটিগুলো সব এন্ডপয়েন্টে প্রযোজ্য। সব ত্রুটি দেখুন

অনুরোধcURLPHPJavaScript

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();

রেসপন্স200

{
  "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
  }
}