Référence · Fichiers

Lister les fichiers

GET /v1/files

Liste les fichiers des organisations dans lesquelles l'utilisateur peut voir les fichiers, du plus récent au plus ancien.

Réponse paginée : les éléments se trouvent dans data et les informations de la page dans meta. Pagination et filtres

Paramètres

Nom	Type	Description
`organization`	`string`	uid d'une organisation, pour ne renvoyer que ses éléments (voir `/organizations`).
`q`	`string`	Partie du nom, 100 caractères maximum.
`type`	`string`	Type de fichier, par exemple `image` ou `video`.
`archived`	`integer`	`1` pour les fichiers archivés uniquement ou `0` pour les fichiers non archivés uniquement. Sans ce paramètre, tous les fichiers sont renvoyés.
`page`	`integer`	Page, à partir de 1. Par défaut : 1.
`per_page`	`integer`	Éléments par page, de 1 à 100. Par défaut : 50.

Champs de chaque élément

uid string: Identifiant du fichier.
name string: Nom du fichier dans le panneau de contrôle.
type string: Type de fichier, par exemple image ou video.
duration integer: Durée, en secondes.
archived boolean: true si le fichier est archivé.
organization object: Organisation du fichier : uid et name.

Erreurs possibles

400 invalid_parameter Un paramètre a une valeur invalide, par exemple per_page au-delà du maximum.
404 organization_not_found Le paramètre organization indiqué ne correspond à aucune organisation dans laquelle l'utilisateur peut voir ce type d'élément.
Les erreurs de clé et de limite s'appliquent à tous les endpoints. Voir toutes les erreurs

RequêtecURLPHPJavaScript

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

Réponse200

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