Referensi · File

Daftar file

GET /v1/files

Menampilkan daftar file dari organisasi tempat pengguna dapat melihat file, dari yang terbaru hingga yang terlama.

Respons dipaginasi: item dikirim dalam data dan informasi halaman dalam meta. Paginasi dan filter

Parameter

Nama	Jenis	Deskripsi
`organization`	`string`	uid organisasi, untuk menampilkan item dari organisasi itu saja (lihat `/organizations`).
`q`	`string`	Bagian dari nama, hingga 100 karakter.
`type`	`string`	Jenis file, seperti `image` atau `video`.
`archived`	`integer`	`1` untuk file yang diarsipkan saja atau `0` untuk file yang tidak diarsipkan saja. Tanpa parameter ini, semua file ditampilkan.
`page`	`integer`	Halaman, mulai dari 1. Default: 1.
`per_page`	`integer`	Item per halaman, dari 1 hingga 100. Default: 50.

Field setiap item

uid string: ID file.
name string: Nama file di panel kontrol.
type string: Jenis file, seperti image atau video.
duration integer: Durasi, dalam detik.
archived boolean: true jika file diarsipkan.
organization object: Organisasi file: uid dan name.

Kemungkinan error

400 invalid_parameter Sebuah parameter memiliki nilai yang tidak valid, misalnya per_page di atas batas maksimum.
404 organization_not_found organization yang diberikan bukan organisasi tempat pengguna dapat melihat jenis item ini.
Error kunci dan batas permintaan berlaku untuk semua endpoint. Lihat semua error

PermintaancURLPHPJavaScript

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

Respons200

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