Referencia · Archivos

Ver un archivo

Devuelve un archivo a partir de su uid, con el tamaño, la resolución, la URL del archivo original y las listas de reproducción en las que está.

Parámetro de ruta

Campos de la respuesta

uid string

Identificador del archivo.

name string

Nombre del archivo en el panel.

type string

Tipo de archivo, como image o video.

duration integer

Duración, en segundos.

archived boolean

true si el archivo está archivado.

organization object

Organización del archivo: uid y name.

size integer

Tamaño del archivo original, en bytes.

width integer

Ancho del archivo original, en píxeles.

height integer

Alto del archivo original, en píxeles.

aspect_ratio string

Relación entre ancho y alto, como 1.78.

url string

URL del archivo original, o un texto vacío si no está disponible.

scheduled boolean

true si el archivo tiene una programación activa.

playlists array

Listas de reproducción en las que está el archivo (uid, name y organization). Solo aparecen las listas que el usuario puede ver.

Errores posibles

• 404 not_found El endpoint no existe, o bien el elemento no existe o pertenece a una organización que el usuario no puede ver.
• Los errores de clave y de límite valen para todos los endpoints. Ver todos los errores

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