Tagairt · Comhaid

Liostaigh comhaid

GET /v1/files

Liostaíonn sé comhaid na n-eagraíochtaí inar féidir leis an úsáideoir comhaid a fheiceáil, ón gceann is nuaí go dtí an ceann is sine.

Freagra roinnte ina leathanaigh: tagann na míreanna in data agus faisnéis an leathanaigh in meta. Uimhriú leathanach agus scagairí

Paraiméadair

Ainm	Cineál	Cur síos
`organization`	`string`	uid eagraíochta, chun a míreanna siúd amháin a fháil (féach `/organizations`).
`q`	`string`	Cuid den ainm, suas le 100 carachtar.
`type`	`string`	Cineál comhaid, mar shampla `image` nó `video`.
`archived`	`integer`	`1` le haghaidh comhad cartlannaithe amháin nó `0` le haghaidh comhad neamhchartlannaithe amháin. Gan an paraiméadar, tagann gach comhad.
`page`	`integer`	Leathanach, ag tosú ag 1. Réamhshocrú: 1.
`per_page`	`integer`	Míreanna in aghaidh an leathanaigh, ó 1 go 100. Réamhshocrú: 50.

Réimsí gach míre

uid string: Aitheantóir an chomhaid.
name string: Ainm an chomhaid sa Phainéal Rialaithe.
type string: Cineál comhaid, mar shampla image nó video.
duration integer: Fad, i soicindí.
archived boolean: true má tá an comhad cartlannaithe.
organization object: Eagraíocht an chomhaid: uid agus name.

Earráidí féideartha

400 invalid_parameter Tá luach neamhbhailí ag paraiméadar, mar shampla per_page os cionn an uasmhéid.
404 organization_not_found Níl an organization a tugadh ar cheann de na heagraíochtaí inar féidir leis an úsáideoir an cineál seo míre a fheiceáil.
Bíonn feidhm ag earráidí eochrach agus teorann ar gach críochphointe. Féach ar gach earráid

IarratascURLPHPJavaScript

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

Freagra200

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