コンテンツにスキップ

API利用時の重要事項

公開状態による制御

APIでは以下の条件でファイルの表示・非表示が制御されます:

  1. 全ファイル表示の場合:
  2. show_all=trueパラメータ かつ fullaccess権限
  3. または 管理画面にログイン済み

  4. 公開ファイルのみ表示の場合:

  5. 公開設定されたファイルのみアクセス可能
  6. 公開期限も考慮: 公開期限が設定されている場合、現在時刻が期限内のファイルのみアクセス可能

公開期限機能

  • published_until: ファイルの公開期限を設定可能(null = 期限なし)
  • published_with_expiry: 公開期限を考慮した実際の公開状態を返す
  • published_status_text: 公開状態の表示文字列を返す
  • 「公開」: 期限なしで公開中
  • 「公開(2024/12/31 23:59まで)」: 期限付きで公開中
  • 「公開期限切れ」: 公開設定だが期限切れ
  • 「非公開」: 非公開設定

ページング制限

  • per_pageパラメータは最大100件まで指定可能
  • 100件を超える値が指定された場合は、デフォルトの20件に自動調整されます

フォルダフィルタリング

  • folder_idパラメータ指定時に該当フォルダが存在しない場合は404エラーが返されます
  • フォルダIDが0以下の場合はフィルタリングが適用されません

エラー処理

  • すべてのAPIで統一されたエラーハンドリングが実装されています
  • サーバーエラー発生時は500エラーと共に問い合わせ番号(inquiry number)が返されます

CORS対応

  • すべてのAPIでCross-Origin Resource Sharing(CORS)に対応しています
  • プリフライトリクエスト(OPTIONS)にも対応
  • エラー時はより柔軟なCORS設定が適用されます