Assets APIの概要
Assets APIは、メディアライブラリに保存したアセット(画像や動画などのファイル)をCDN経由で配信するためのAPIです。コンテンツから参照しているアセットを、WebサイトやアプリでURLとして読み込み、表示する用途で利用します。
配信用URLとAPIキー
Assets APIは、アセットごとの配信用URLにアクセスして利用します。配信用URLには、対象プロジェクトを指定するAPIキーが含まれます。APIキーはプロジェクトごとに発行され、CDN APIやPreview APIのようなアクセストークン(Bearer)は使いません。配信用URLの取得方法やリクエストの送り方は、リクエストのページを参照してください。
配信されるアセット
Assets APIで配信されるのは、公開状態のアセットだけです。非公開のアセットにアクセスすると、404エラーになります。アセットの公開と非公開は、メディアライブラリで切り替えます。
画像の変換
画像の配信はFastly Image Optimizerを経由します。配信用URLにFastly Image Optimizerのクエリパラメータ(width や format など)を付与すると、リサイズやフォーマット変換などの画像変換を配信時に行えます。利用できるパラメータは、クエリのページを参照してください。
このセクションの構成
- リクエスト: 配信用URLの取得、エンドポイント、APIキーの渡し方
- メソッド: Get an imageとGet any assetの使い分け、動画などで使うRange Request
- クエリ: 配信用URLのクエリパラメータと、Fastly Image Optimizerによる画像変換
- エラー: エラー時に返るステータスコード
各メソッドのパラメータの詳細は、Craft Cross CMSのAPIリファレンスも参照してください。