Tagairt · Comhaid

Faigh comhad

GET /v1/files/{uid}

Taispeánann sé comhad de réir a uid, lena mhéid, a thaifeach, URL an bhunchomhaid agus na seinmliostaí ina bhfuil sé.

Paraiméadar cosáin

AinmCineálCur síos
uidstringuid an chomhaid.

Réimsí an fhreagra

uid string
Aitheantóir an chomhaid.
name string
Ainm an chomhaid sa Phainéal Rialaithe.
type string
Cineál comhaid, mar shampla image nó video.
duration integer
Fad, i soicindí.
archived boolean
true má tá an comhad cartlannaithe.
organization object
Eagraíocht an chomhaid: uid agus name.
size integer
Méid an bhunchomhaid, i mbearta.
width integer
Leithead an bhunchomhaid, i bpicteilíní.
height integer
Airde an bhunchomhaid, i bpicteilíní.
aspect_ratio string
An cóimheas idir an leithead agus an airde, mar shampla 1.78.
url string
URL an bhunchomhaid, nó teaghrán folamh mura bhfuil sé ar fáil.
scheduled boolean
true má tá sceideal gníomhach ag an gcomhad.
playlists array
Na seinmliostaí ina bhfuil an comhad (uid, name agus organization). Ní liostaítear ach na seinmliostaí is féidir leis an úsáideoir a fheiceáil.

Earráidí féideartha

  • 404 not_found Níl an críochphointe ann, nó níl an mhír ann nó baineann sí le heagraíocht nach féidir leis an úsáideoir a fheiceáil.
  • Bíonn feidhm ag earráidí eochrach agus teorann ar gach críochphointe. Féach ar gach earráid
Iarratas
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();
Freagra200
{
  "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"
        }
      }
    ]
  }
}
Mír nach bhfuil ann nó gan rochtain404
{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}