Referencia · Ficheiros

Listar ficheiros

GET /v1/files

Devolve os ficheiros das organizacións nas que o usuario pode ver ficheiros, do máis recente ao máis antigo.

Resposta paxinada: os elementos veñen en data e a información da páxina, en meta. Paxinación e filtros

Parámetros

Nome	Tipo	Descrición
`organization`	`string`	uid dunha organización, para obter só os seus elementos (consulte `/organizations`).
`q`	`string`	Parte do nome, ata 100 caracteres.
`type`	`string`	Tipo de ficheiro, como `image` ou `video`.
`archived`	`integer`	`1` para obter só os arquivados ou `0` para obter só os non arquivados. Sen este parámetro, devólvense todos.
`page`	`integer`	Páxina, a partir de 1. Valor predeterminado: 1.
`per_page`	`integer`	Elementos por páxina, de 1 a 100. Valor predeterminado: 50.

Campos de cada elemento

uid string: Identificador do ficheiro.
name string: Nome do ficheiro no panel.
type string: Tipo de ficheiro, como image ou video.
duration integer: Duración, en segundos.
archived boolean: true se o ficheiro está arquivado.
organization object: Organización do ficheiro: uid e name.

Erros posibles

400 invalid_parameter Un parámetro ten un valor non válido, como per_page por riba do máximo.
404 organization_not_found O organization indicado non corresponde a unha organización na que o usuario poida ver este tipo de elemento.
Os erros de chave e de límite aplícanse a todos os endpoints. Ver todos os erros

SolicitudecURLPHPJavaScript

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

Resposta200

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