Referans · Fichye

Lis fichye yo

GET /v1/files

Bay lis fichye yo nan òganizasyon kote itilizatè a ka wè fichye, soti nan pi nouvo yo rive nan pi ansyen yo.

Repons divize an paj: eleman yo vini nan data, epi enfòmasyon sou paj la vini nan meta. Paginasyon ak filtè

Paramèt

Non	Tip	Deskripsyon
`organization`	`string`	uid yon òganizasyon, pou jwenn sèlman eleman pa l yo (gade `/organizations`).
`q`	`string`	Yon pati nan non an, jiska 100 karaktè.
`type`	`string`	Tip fichye a, tankou `image` oswa `video`.
`archived`	`integer`	`1` pou fichye ki achive yo sèlman oswa `0` pou fichye ki pa achive yo sèlman. San paramèt la, tout fichye yo vini.
`page`	`integer`	Paj, apati 1. Pa defo: 1.
`per_page`	`integer`	Kantite eleman pa paj, soti 1 rive 100. Pa defo: 50.

Chan chak eleman

uid string: Idantifyan fichye a.
name string: Non fichye a nan panèl la.
type string: Tip fichye a, tankou image oswa video.
duration integer: Dire, an segonn.
archived boolean: true si fichye a achive.
organization object: Òganizasyon fichye a: uid ak name.

Erè ki posib

400 invalid_parameter Yon paramèt gen yon valè ki pa valab, tankou per_page ki depase maksimòm nan.
404 organization_not_found organization yo bay la pa koresponn ak yon òganizasyon kote itilizatè a ka wè kalite eleman sa a.
Erè kle ak erè limit yo aplike pou tout endpoint yo. Wè tout erè yo

DemanncURLPHPJavaScript

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

Repons200

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