REST API リファレンス
- ドキュメントトップ
-
共通
-
プッシュ通知
-
会員管理・認証
-
データストア
-
ファイルストア
-
スクリプト
共通ドキュメント
公開ファイル取得
Contents |
公開ファイル取得APIについて
指定アプリケーションのファイル取得を、APIの認証なしで行います。
ただし、管理画面の公開ファイル設定で、HTTPSによる取得を有効化し、
指定ファイルのACLでread権限が全許可されている場合のみ取得可能です。
基本仕様
公開ファイル取得APIは、アプリケーションキーなどのアプリを識別する値を利用しないため、
APIパスでアプリケーションIDを指定する必要があります。
アプリケーションIDは、管理画面をブラウザで閲覧しているときのURLのうち、
/applications/より後ろの文字列となります。
- APIパス:/applications/アプリケーションID/publicFiles/ファイル名
- メソッド:GET
Etag
公開ファイル取得APIは、レスポンスヘッダーにEtagが付与されています。
このEtagをリクエストヘッダーのIf-None-Matchに追加することで、HTTPステータスが304で返却されます。
304で返却される場合、ファイルを再度ダウンロードしないため、データ通信量を削減することができます。
リクエストヘッダー
フィールド名 | 内容 | 必須 |
---|---|---|
If-None-Match | レスポンスで受け取ったEtagを指定 | △ |
- If-None-Matchをヘッダーに指定しなくても公開ファイルAPIは実行できます。
リクエストコンテント
なし
HTTPステータス
バイナリデータ
ステータスコード | 内容 |
---|---|
200 | 正常終了 |
304 | ファイル未更新のため、前回のダウンロード内容を表示 |
レスポンスヘッダー
フィールド名 | 内容 |
---|---|
Content-Type | ファイル登録時に指定したコンテントタイプ |
Etag | サーバーが生成する任意のトークン |
レスポンスコンテント
パラメータ名 | 説明 | データ型 |
---|---|---|
- | ファイルデータ | バイナリデータ |
リクエストサンプル
curl -X GET \
https://mbaas.api.nifcloud.com/2013-09-01/applications/jSyf7d6kUiS9zzk6/publicFiles/test.jpg
レスポンスサンプル
HTTP/1.1 200 OK
Etag: W/"aaaabbbbccccddddeeeeffffgggghhhh"
バイナリデータ
リクエストサンプル(If-None-Matchを指定する)
curl -X GET \
-H "If-None-Match: W/\"aaaabbbbccccddddeeeeffffgggghhhh\"" \
https://mbaas.api.nifcloud.com/2013-09-01/applications/jSyf7d6kUiS9zzk6/publicFiles/test.jpg
レスポンスサンプル(If-None-Matchを指定する)
HTTP/1.1 304 Not Modified
Etag: W/"aaaabbbbccccddddeeeeffffgggghhhh"
バイナリデータ
お探しの内容が見つからなかった場合はユーザーコミュニティ
もご活用ください。(回答保証はいたしかねます)
なお、 Expertプラン以上のお客様はテクニカルサポートにてご質問を承らせて頂きます。
推奨画面サイズ1024×768px以上