ማጣቀሻ · ፋይሎች

ፋይሎችን መዘርዘር

GET /v1/files

ተጠቃሚው ፋይሎችን ማየት በሚችልባቸው ድርጅቶች ውስጥ ያሉትን ፋይሎች ከአዲሱ ወደ አሮጌው ይዘረዝራል።

በገጾች የተከፋፈለ ምላሽ፦ ንጥሎቹ በdata ውስጥ፣ የገጹ መረጃ ደግሞ በmeta ውስጥ ይመጣሉ። ገጽ መከፋፈል እና ማጣሪያዎች

ፓራሜትሮች

ስም	አይነት	መግለጫ
`organization`	`string`	የአንድ ድርጅት uid፣ የእሱን ንጥሎች ብቻ ለማምጣት (`/organizations`ን ይመልከቱ)።
`q`	`string`	የስሙ ክፍል፣ እስከ 100 ቁምፊዎች።
`type`	`string`	የፋይሉ አይነት፣ ለምሳሌ `image` ወይም `video`።
`archived`	`integer`	በማህደር የተቀመጡትን ብቻ ለማግኘት `1`፣ በማህደር ያልተቀመጡትን ብቻ ለማግኘት `0`። ፓራሜትሩ ከሌለ ሁሉም ይመጣሉ።
`page`	`integer`	ገጽ፣ ከ1 ጀምሮ። ነባሪ፦ 1።
`per_page`	`integer`	በአንድ ገጽ ያሉ ንጥሎች፣ ከ1 እስከ 100። ነባሪ፦ 50።

የእያንዳንዱ ንጥል መስኮች

uid string: የፋይሉ ለዪ።
name string: በቁጥጥር ፓነሉ ውስጥ ያለው የፋይሉ ስም።
type string: የፋይሉ አይነት፣ ለምሳሌ image ወይም video።
duration integer: የቆይታ ጊዜ፣ በሰከንድ።
archived boolean: ፋይሉ በማህደር ከተቀመጠ true።
organization object: የፋይሉ ድርጅት፦ uid እና name።

ሊከሰቱ የሚችሉ ስህተቶች

400 invalid_parameter አንድ ፓራሜትር ልክ ያልሆነ ዋጋ አለው፤ ለምሳሌ ከከፍተኛው በላይ የሆነ per_page።
404 organization_not_found የተሰጠው organization ተጠቃሚው ይህን አይነት ንጥል ማየት የሚችልበት ድርጅት አይደለም።
የቁልፍ እና የገደብ ስህተቶች ለሁሉም ኢንድፖይንቶች ይሠራሉ። ሁሉንም ስህተቶች ይመልከቱ

ጥያቄcURLPHPJavaScript

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

ምላሽ200

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