सन्दर्भ · फाइलहरू

एउटा फाइल हेर्नुहोस्

GET /v1/files/{uid}

uid अनुसार एउटा फाइल देखाउँछ, साथमा त्यसको आकार, रिजोल्युसन, मूल फाइलको URL र त्यो समावेश भएका प्लेलिस्टहरू।

पाथ प्यारामिटर

नामप्रकारविवरण
uidstringफाइलको 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
मूल फाइलको URL, वा उपलब्ध नभए खाली पाठ।
scheduled boolean
फाइलको सक्रिय तालिका भए true।
playlists array
फाइल समावेश भएका प्लेलिस्टहरू (uid, name र organization)। प्रयोगकर्ताले हेर्न पाउने प्लेलिस्टहरू मात्र देखिन्छन्।

सम्भावित त्रुटिहरू

  • 404 not_found एन्डप्वाइन्ट अवस्थित छैन, वा आइटम अवस्थित छैन वा प्रयोगकर्ताले हेर्न नपाउने संस्थाको हो।
  • कुञ्जी र सीमासम्बन्धी त्रुटिहरू सबै एन्डप्वाइन्टमा लागू हुन्छन्। सबै त्रुटिहरू हेर्नुहोस्
अनुरोध
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."
  }
}