Referentie · Bestanden

Bestanden opvragen

GET /v1/files

Geeft de bestanden van de organisaties waarin de gebruiker bestanden kan zien, van nieuw naar oud.

Gepagineerd antwoord: de items staan in data en de pagina-informatie in meta. Paginering en filters

Parameters

Naam	Type	Beschrijving
`organization`	`string`	uid van een organisatie, om alleen de items daarvan op te halen (zie `/organizations`).
`q`	`string`	Deel van de naam, maximaal 100 tekens.
`type`	`string`	Bestandstype, zoals `image` of `video`.
`archived`	`integer`	`1` voor alleen gearchiveerde of `0` voor alleen niet-gearchiveerde bestanden. Zonder deze parameter komen alle bestanden terug.
`page`	`integer`	Pagina, vanaf 1. Standaard: 1.
`per_page`	`integer`	Items per pagina, van 1 tot 100. Standaard: 50.

Velden van elk item

uid string: ID van het bestand.
name string: Naam van het bestand in het beheerpaneel.
type string: Bestandstype, zoals image of video.
duration integer: Duur, in seconden.
archived boolean: true als het bestand gearchiveerd is.
organization object: Organisatie van het bestand: uid en name.

Mogelijke fouten

400 invalid_parameter Een parameter heeft een ongeldige waarde, zoals per_page boven het maximum.
404 organization_not_found De opgegeven organization is geen organisatie waarin de gebruiker dit type item kan zien.
Fouten rond de sleutel en de verzoeklimiet gelden voor alle endpoints. Alle fouten bekijken

VerzoekcURLPHPJavaScript

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

Antwoord200

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