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

ストレージ API(Storage API)

ストレージ API は、ファイル・画像・動画・PDF・CSV などのバイナリデータを安全に保存・配信するための API です。

利用開始と同時に御社専用の Object Storage が自動構成されます。
アップロード・ダウンロード・URL 生成・削除のエンドポイントが自動的に提供されるため、
ストレージ基盤を自前で構築・運用する必要がありません。


3 つのアクセスモード

ストレージ API は、ファイルへのアクセス方法に応じて 3 つのモードを提供しています。

Public(認証なし)

認証不要でファイルにアクセスできるモードです。
商品画像・公開ドキュメント・静的リソースなど、誰でも参照できてよいファイルの配信に適しています。

  • 認証トークン不要でアップロード・ダウンロードが可能
  • アップロードしたファイルの公開 URL を取得できます

User スコープ(認証ユーザー単位)

IAM API と連携し、ログインユーザーごとに分離されたストレージ領域を提供します。
ユーザーは自分がアップロードしたファイルにのみアクセスでき、他のユーザーのファイルは参照できません。

  • プロフィール画像・添付ファイル・個人ドキュメントなど、ユーザー固有のファイル管理に適しています
  • IAM API のユーザートークンによる認証が必要です

Organization スコープ(組織単位)

IAM API の Organization(組織)と連携し、組織ごとに分離されたストレージ領域を提供します。
同じ組織のメンバーはファイルを共有でき、他の組織からはアクセスできません。

  • 部署共有のドキュメント・チームの作業ファイルなど、組織内での共有ファイル管理に適しています
  • IAM API の組織トークンによる認証が必要です

主な機能一覧

機能説明
ファイルアップロード任意のバイナリファイルをアップロード(Public / User / Org 各モード)
ファイルダウンロードアップロードしたファイルを取得
公開 URL 取得アップロード済みファイルの公開アクセス用 URL を生成
ファイル一覧組織単位でのファイル一覧を取得
ファイル削除指定ファイルを削除
専用ストレージ領域ユーザー単位 / 組織単位で分離されたストレージ領域

ストレージエンジン

環境に応じて 2 種類のストレージエンジンを使い分けできます。

エンジン用途特徴
Local StorageTestEnv / DevelopEnvローカルディスクへの保存。テスト・開発用途。本番では使用しない
Object StorageStagingEnv / ProductionEnvクラウドオブジェクトストレージ。本番運用に対応した永続ストレージ

詳細 → ストレージエンジン


IAM API との連携

ストレージ API は、構築時に接続する IAM API を選択することで認証を有効化できます。
認証を有効にすると、IAM API のトークン検証をストレージ API が行い、
不正なアクセスやユーザー間のデータ混在を防ぎます。

Public モードのみを使う場合は IAM API との連携は不要です。


インターフェース

ストレージ API は標準的な HTTP/1 系 REST API として提供されます。
マルチパートフォームによるファイルアップロードに対応しており、
Web フロントエンド・モバイルアプリ・バックエンドシステムなど、どこからでも接続できます。