Inkomba · Amafayela

Bonisa amafayela

GET /v1/files

Ibonisa amafayela ezinhlangano lapho umsebenzisi angabona khona amafayela, kusukela kwamasha kuya kwamadala.

Impendulo ehlukaniswe ngamakhasi: izinto ziza ku-data kanti ulwazi lwekhasi luza ku-meta. Amakhasi nezihlungi

Amapharamitha

IgamaUhloboIncazelo
organizationstringI-uid yenhlangano, ukuze kulethwe izinto zayo kuphela (bona i-/organizations).
qstringIngxenye yegama, kufika ezinhlamvwini ezingu-100.
typestringUhlobo lwefayela, njenge-image noma i-video.
archivedinteger1 kumafayela agciniwe kuphela noma 0 kumafayela angagciniwe kuphela. Ngaphandle kwale pharamitha, kubuya wonke amafayela.
pageintegerIkhasi, kusukela ku-1. Okuzenzakalelayo: 1.
per_pageintegerIzinto ekhasini ngalinye, kusukela ku-1 kuya ku-100. Okuzenzakalelayo: 50.

Izinkambu zento ngayinye

uid string
Isihlonzi sefayela.
name string
Igama lefayela ephanelini yokulawula.
type string
Uhlobo lwefayela, njenge-image noma i-video.
duration integer
Ubude besikhathi, ngemizuzwana.
archived boolean
true uma ifayela ligciniwe.
organization object
Inhlangano yefayela: uid ne-name.

Amaphutha angenzeka

  • 400 invalid_parameter Ipharamitha inenani elingavumelekile, njenge-per_page engaphezu komkhawulo ophezulu.
  • 404 organization_not_found I-organization enikeziwe akuyona inhlangano lapho umsebenzisi angabona khona lolu hlobo lwento.
  • Amaphutha okhiye nawomkhawulo asebenza kuwo wonke ama-endpoint. Bona wonke amaphutha
Isicelo
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();
Impendulo200
{
  "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
  }
}