Referência · Ficheiros

Listar ficheiros

GET /v1/files

Lista os ficheiros das empresas em que o utilizador pode ver ficheiros, dos mais recentes para os mais antigos.

Resposta paginada: os itens vêm em data e as informações da página, em meta. Paginação e filtros

Parâmetros

Nome	Tipo	Descrição
`organization`	`string`	uid de uma empresa, para devolver apenas os itens dessa empresa (consulte `/organizations`).
`q`	`string`	Parte do nome, com até 100 caracteres.
`type`	`string`	Tipo de ficheiro, como `image` ou `video`.
`archived`	`integer`	`1` para obter apenas os arquivados ou `0` para obter apenas os não arquivados. Sem o parâmetro, vêm todos.
`page`	`integer`	Página, a partir de 1. Predefinição: 1.
`per_page`	`integer`	Itens por página, de 1 a 100. Predefinição: 50.

Campos de cada item

uid string: Identificador do ficheiro.
name string: Nome do ficheiro no painel.
type string: Tipo de ficheiro, como image ou video.
duration integer: Duração, em segundos.
archived boolean: true se o ficheiro estiver arquivado.
organization object: Empresa do ficheiro: uid e name.

Erros possíveis

400 invalid_parameter Um parâmetro tem um valor inválido, como per_page acima do máximo.
404 organization_not_found O organization indicado não corresponde a uma empresa em que o utilizador possa ver este tipo de item.
Os erros de chave e de limite aplicam-se a todos os endpoints. Ver todos os erros

PedidocURLPHPJavaScript

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