メインコンテンツまでスキップ

ファイル一覧取得 API

概要

カスタムストレージに保存されたファイルの一覧を取得する API です。アクセストークン取得 APIで取得したアクセストークンで Bearer 認証し、条件に応じたファイル一覧とページネーション用のトークンを返します。アップロード・ダウンロード用の署名付き URL 取得で個別ファイルをアップロード・ダウンロードできます。

事前準備

1. カスタムストレージの有効化

本 API はカスタムストレージが有効な場合にのみ利用できます。事前にカスタムストレージが有効化されているかご確認ください。

2. アクセストークンの取得

アクセストークン取得 APIを呼び出し、access_token を取得してください。本 API ではこのトークンを Bearer 認証に使用します。

3. IP アドレス制限(任意)

必要に応じてIP アドレス制限を設定できます。設定している場合は、許可された送信元 IP からのみリクエスト可能です。

使用手順

1. ファイル一覧の取得

Bearer トークンおよび JSON ボディ(取得条件)を付与して POST リクエストします。

ヒント

実装方法の詳細については、OpenAPI リファレンス(auth-getfilelist)を参照してください。

2. ファイルのアップロード・ダウンロード

一覧で取得した name などを用いて、アップロード・ダウンロード用の署名付き URL 取得に従い、個別ファイルをアップロード・ダウンロードします。

警告

アクセストークン有効期限: アクセストークンの有効期限を過ぎた場合は、アクセストークン取得 APIで再取得してください。