Referenco · Dosieroj

Listigi dosierojn

GET /v1/files

Listigas la dosierojn de la organizaĵoj, en kiuj la uzanto povas vidi dosierojn, de la plej novaj al la plej malnovaj.

Paĝigita respondo: la eroj venas en data kaj la informoj pri la paĝo en meta. Paĝigo kaj filtriloj

Parametroj

Nomo	Tipo	Priskribo
`organization`	`string`	uid de organizaĵo, por ricevi nur ĝiajn erojn (vidu `/organizations`).
`q`	`string`	Parto de la nomo, ĝis 100 signoj.
`type`	`string`	Tipo de la dosiero, ekzemple `image` aŭ `video`.
`archived`	`integer`	`1` por nur la arĥivitaj aŭ `0` por nur la nearĥivitaj. Sen la parametro, venas ĉiuj.
`page`	`integer`	Paĝo, ekde 1. Defaŭlte: 1.
`per_page`	`integer`	Eroj por paĝo, de 1 ĝis 100. Defaŭlte: 50.

Kampoj de ĉiu ero

uid string: Identigilo de la dosiero.
name string: Nomo de la dosiero en la kontrolpanelo.
type string: Tipo de la dosiero, ekzemple image aŭ video.
duration integer: Daŭro, en sekundoj.
archived boolean: true se la dosiero estas arĥivita.
organization object: Organizaĵo de la dosiero: uid kaj name.

Eblaj eraroj

400 invalid_parameter Parametro havas nevalidan valoron, ekzemple per_page super la maksimumo.
404 organization_not_found La indikita organization ne estas organizaĵo, en kiu la uzanto povas vidi ĉi tiun tipon de eroj.
La eraroj pri ŝlosilo kaj limo validas por ĉiuj finpunktoj. Vidi ĉiujn erarojn

PetocURLPHPJavaScript

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

Respondo200

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