חומר עזר · קבצים

פרטי קובץ

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