Tixraac · Faylal

Eeg faylalka

GET /v1/files

Wuxuu liis gareeyaa faylalka ururada uu isticmaaluhu ku arki karo faylalka, kuwa ugu cusub ilaa kuwa ugu da'da weyn.

Jawaab bogaysan: walxaha waxay ku yimaadaan data, macluumaadka bogguna wuxuu ku yimaadaa meta. Bogaynta iyo shaandhaynta

Halbeegyada

Magac	Nooc	Sharaxaad
`organization`	`string`	uid-ka urur, si loo soo celiyo walxihiisa oo keliya (eeg `/organizations`).
`q`	`string`	Qayb ka mid ah magaca, ilaa 100 xaraf.
`type`	`string`	Nooca faylka, sida `image` ama `video`.
`archived`	`integer`	`1` kuwa la arkiifiyay oo keliya ama `0` kuwa aan la arkiifin oo keliya. Halbeeggan la'aantiis, dhammaan waa la soo celiyaa.
`page`	`integer`	Bogga, laga bilaabo 1. Caadi ahaan: 1.
`per_page`	`integer`	Walxaha bog kasta, 1 ilaa 100. Caadi ahaan: 50.

Goobaha walax kasta

uid string: Aqoonsiga faylka.
name string: Magaca faylka ee guddiga xakamaynta.
type string: Nooca faylka, sida image ama video.
duration integer: Muddada, ilbiriqsiyo ahaan.
archived boolean: true haddii faylka la arkiifiyay.
organization object: Ururka faylka: uid iyo name.

Khaladaadka suurtagalka ah

400 invalid_parameter Halbeeg ayaa leh qiime khaldan, sida per_page oo ka badan inta ugu badan.
404 organization_not_found organization-ka la bixiyay ma aha urur uu isticmaaluhu ku arki karo noocan walxaha ah.
Khaladaadka furaha iyo xadka waxay khuseeyaan dhammaan endpoint-yada. Eeg dhammaan khaladaadka

CodsicURLPHPJavaScript

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

Jawaab200

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