Référence · Fichiers

Consulter un fichier

Renvoie un fichier à partir de son uid, avec sa taille, sa résolution, l'URL du fichier original et les playlists qui le contiennent.

Paramètre de chemin

Champs de la réponse

uid string

Identifiant du fichier.

name string

Nom du fichier dans le panneau de contrôle.

type string

Type de fichier, par exemple image ou video.

duration integer

Durée, en secondes.

archived boolean

true si le fichier est archivé.

organization object

Organisation du fichier : uid et name.

size integer

Taille du fichier original, en octets.

width integer

Largeur du fichier original, en pixels.

height integer

Hauteur du fichier original, en pixels.

aspect_ratio string

Rapport entre la largeur et la hauteur, par exemple 1.78.

url string

URL du fichier original, ou chaîne vide s'il n'est pas disponible.

scheduled boolean

true si le fichier a une programmation active.

playlists array

Playlists qui contiennent le fichier (uid, name et organization). Seules les playlists que l'utilisateur peut voir sont listées.

Erreurs possibles

• 404 not_found L'endpoint n'existe pas, ou l'élément n'existe pas ou appartient à une organisation que l'utilisateur ne peut pas voir.
• Les erreurs de clé et de limite s'appliquent à tous les endpoints. Voir toutes les erreurs

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

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

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