Referencia · Archivos

Listar archivos

GET /v1/files

Devuelve los archivos de las organizaciones en las que el usuario puede ver archivos, de los más recientes a los más antiguos.

Respuesta paginada: los elementos vienen en data y la información de la página, en meta. Paginación y filtros

Parámetros

Nombre	Tipo	Descripción
`organization`	`string`	uid de una organización, para obtener solo sus elementos (consulte `/organizations`).
`q`	`string`	Parte del nombre, hasta 100 caracteres.
`type`	`string`	Tipo de archivo, como `image` o `video`.
`archived`	`integer`	`1` para obtener solo los archivados o `0` para obtener solo los no archivados. Sin este parámetro, se devuelven todos.
`page`	`integer`	Página, a partir de 1. Por defecto: 1.
`per_page`	`integer`	Elementos por página, de 1 a 100. Por defecto: 50.

Campos de cada elemento

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.

Posibles errores

400 invalid_parameter Un parámetro tiene un valor no válido, como per_page por encima del máximo.
404 organization_not_found El organization indicado no corresponde a una organización en la que el usuario pueda ver este tipo de elemento.
Los errores de clave y de límite se aplican a todos los endpoints. Ver todos los errores

PeticióncURLPHPJavaScript

curl "https://api.on-cloud.live/v1/files?per_page=2" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/files?per_page=2');
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?per_page=2', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data, meta } = await res.json();

Respuesta200

{
  "data": [
    {
      "uid": "c20ad4d76fe97759aa27a0c99bff6710",
      "name": "Horário de funcionamento",
      "type": "image",
      "duration": 8,
      "archived": false,
      "organization": {
        "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
        "name": "Loja Shopping Norte"
      }
    },
    {
      "uid": "6512bd43d9caa6e02c990b0a82652dca",
      "name": "Cardápio do dia",
      "type": "image",
      "duration": 10,
      "archived": false,
      "organization": {
        "uid": "8f14e45fceea167a5a36dedd4bea2543",
        "name": "Loja Centro"
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 2,
    "total": 3,
    "total_pages": 2
  }
}