Referens · Filer

Hämta en fil

GET /v1/files/{uid}

Visar en fil utifrån dess uid, med storlek, upplösning, URL till originalfilen och de spellistor som filen ingår i.

Sökvägsparameter

Namn	Typ	Beskrivning
`uid`	`string`	uid för filen.

Fält i svaret

uid string: Filens id.
name string: Filens namn i kontrollpanelen.
type string: Filtyp, till exempel image eller video.
duration integer: Längd i sekunder.
archived boolean: true om filen är arkiverad.
organization object: Filens organisation: uid och name.
size integer: Originalfilens storlek i byte.
width integer: Originalfilens bredd i pixlar.
height integer: Originalfilens höjd i pixlar.
aspect_ratio string: Förhållandet mellan bredd och höjd, till exempel 1.78.
url string: URL till originalfilen, eller en tom sträng om den inte är tillgänglig.
scheduled boolean: true om filen har en aktiv schemaläggning.
playlists array: Spellistor som filen ingår i (uid, name och organization). Bara spellistor som användaren kan se visas.

Möjliga fel

404 not_found Endpointen finns inte, eller så finns objektet inte eller tillhör en organisation som användaren inte kan se.
Fel som rör nyckeln och anropsgränsen gäller för alla endpoints. Visa alla fel

AnropcURLPHPJavaScript

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

Svar200

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

Objekt som inte finns eller saknad åtkomst404

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