레퍼런스 · 파일

파일 목록 조회

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