חומר עזר · קבצים

רשימת קבצים

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