Referência · Arquivos

Listar arquivos

GET /v1/files

Lista os arquivos das empresas em que o usuário pode ver arquivos, dos mais novos 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 trazer só os itens dela (veja `/organizations`).
`q`	`string`	Parte do nome, com até 100 caracteres.
`type`	`string`	Tipo do arquivo, como `image` ou `video`.
`archived`	`integer`	`1` para só os arquivados ou `0` para só os não arquivados. Sem o parâmetro, vêm todos.
`page`	`integer`	Página, a partir de 1. Padrão: 1.
`per_page`	`integer`	Itens por página, de 1 a 100. Padrão: 50.

Campos de cada item

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

Erros possíveis

400 invalid_parameter Um parâmetro tem valor inválido, como per_page acima do máximo.
404 organization_not_found O organization informado não é de uma empresa em que o usuário pode ver esse tipo de item.
Os erros de chave e de limite valem para todos os endpoints. Ver todos os erros

RequisiçãocURLPHPJavaScript

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