Cyfeirnod · Ffeiliau

Gweld ffeil

GET /v1/files/{uid}

Yn dangos ffeil yn ôl ei uid, gyda'i maint, ei chydraniad, URL y ffeil wreiddiol a'r rhestrau chwarae y mae ynddynt.

Paramedr yn y llwybr

Enw	Math	Disgrifiad
`uid`	`string`	uid y ffeil.

Meysydd yr ymateb

uid string: Dynodydd y ffeil.
name string: Enw'r ffeil yn y Panel Rheoli.
type string: Math o ffeil, fel image neu video.
duration integer: Hyd, mewn eiliadau.
archived boolean: true os yw'r ffeil wedi'i harchifo.
organization object: Sefydliad y ffeil: uid a name.
size integer: Maint y ffeil wreiddiol, mewn beitiau.
width integer: Lled y ffeil wreiddiol, mewn picseli.
height integer: Uchder y ffeil wreiddiol, mewn picseli.
aspect_ratio string: Cymhareb y lled i'r uchder, fel 1.78.
url string: URL y ffeil wreiddiol, neu linyn gwag os nad yw ar gael.
scheduled boolean: true os oes gan y ffeil amserlen weithredol.
playlists array: Y rhestrau chwarae y mae'r ffeil ynddynt (uid, name a organization). Dim ond y rhestrau chwarae y gall y defnyddiwr eu gweld sy'n cael eu dangos.

Gwallau posibl

404 not_found Dydy'r pwynt terfyn ddim yn bodoli, neu dydy'r eitem ddim yn bodoli neu mae'n perthyn i sefydliad na all y defnyddiwr ei weld.
Mae gwallau allwedd a therfyn ceisiadau yn berthnasol i bob pwynt terfyn. Gweld pob gwall

CaiscURLPHPJavaScript

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

Ymateb200

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

Eitem nad yw'n bodoli neu heb fynediad404

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