Sanggunian · Mga File

Ilista ang mga file

GET /v1/files

Inililista ang mga file ng mga organisasyon kung saan nakikita ng user ang mga file, mula sa pinakabago hanggang sa pinakaluma.

Response na may pagination: nasa data ang mga item at nasa meta ang impormasyon ng pahina. Pagination at mga filter

Mga parameter

Pangalan	Uri	Paglalarawan
`organization`	`string`	uid ng isang organisasyon, para ang mga item lang nito ang makuha (tingnan ang `/organizations`).
`q`	`string`	Bahagi ng pangalan, hanggang 100 character.
`type`	`string`	Uri ng file, gaya ng `image` o `video`.
`archived`	`integer`	`1` para sa mga naka-archive lang o `0` para sa mga hindi naka-archive lang. Kapag wala ang parameter, lahat ay ibinabalik.
`page`	`integer`	Pahina, simula sa 1. Default: 1.
`per_page`	`integer`	Mga item bawat pahina, mula 1 hanggang 100. Default: 50.

Mga field ng bawat item

uid string: Identifier ng file.
name string: Pangalan ng file sa control panel.
type string: Uri ng file, gaya ng image o video.
duration integer: Tagal, sa segundo.
archived boolean: true kung naka-archive ang file.
organization object: Organisasyon ng file: uid at name.

Mga posibleng error

400 invalid_parameter May invalid na value ang isang parameter, gaya ng per_page na lampas sa maximum.
404 organization_not_found Ang ibinigay na organization ay hindi isang organisasyon kung saan nakikita ng user ang ganitong uri ng item.
Umiiral sa lahat ng endpoint ang mga error sa key at sa limitasyon. Tingnan ang lahat ng error

RequestcURLPHPJavaScript

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

Response200

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