REST API リファレンス
- ドキュメントトップ
-
共通
-
プッシュ通知
-
会員管理・認証
-
データストア
-
ファイルストア
-
スクリプト
共通ドキュメント
スクリプト実行
Contents |
スクリプト実行APIについて
登録したスクリプトを実行します。
レスポンスでは、登録したスクリプトの返り値がレスポンスとして返却されます。
基本仕様
スクリプト REST APIを利用する際の仕様は以下のとおりです。
名前 | 説明 |
---|---|
APIのエンドポイント | script.mbaas.api.nifcloud.com |
APIのバージョン | 2015-09-01 |
APIパス | /script/スクリプト名 (.js または .rb で終わるファイル名) |
メソッド | GET/POST/PUT/DELETE |
使用するプロトコル | HTTPS |
文字コード | UTF-8 |
リクエスト
ヘッダー
一部を除き、一般的な API コールで利用するような任意のヘッダーが指定可能です。
以下のヘッダーは認証に必要であるため、これらを上書きするヘッダーは使用できません。
ヘッダー名 | 説明 |
---|---|
host | アクセス先ホスト |
X-NCMB-Application-Key | アプリケーションキー |
X-NCMB-Signature | シグネチャ |
X-NCMB-Timestamp | タイムスタンプ |
X-NCMB-Apps-Session-Token | アプリセッショントークン |
ボディ
各種、一般的な API コールで利用するような任意の文字列が指定可能です。
クエリストリング
各種、一般的な API コールで利用するような任意の文字列が指定可能です。
レスポンス
HTTPステータス
ステータスコード | 内容 | 実行ログに表示されるStatus |
---|---|---|
200 | 正常終了 | DONE |
404 | 未検出 | BEFORE |
500 | Script内部エラー | ERROR |
実行ログに関しては以下のドキュメントを参考にしてください。
スクリプトの実行ログ確認
※「BEFORE」はスクリプトに実行リクエストが送られてから処理が完了するまでの間に確認されるステータスです。
この期間は処理が未完了であり、実行ログが存在しないため、未検出(404)として扱われます。
なお、スクリプトが実行完了すると、エラーの有無によって「BEFORE」から「DONE」または「ERROR」に更新されます。
ヘッダー
登録したスクリプトのレスポンスヘッダー
コンテント
登録したスクリプトのレスポンスボディ
リクエストサンプル
サンプルスクリプト
以下のようなScriptを実行する際のリクエストサンプルとなります。
module.exports = function(req, res) {
res.send("my name is " + req.query.name);
}
GETリクエスト
curl -X GET -G \
-H "X-NCMB-Apps-Session-Token:46MnVgUbwHIXIHp9mowIeh7r2" \
-H "X-NCMB-Application-Key: 549116a86b0ebbec4832d4086a56f36c82a5d64bc6528fa5e6220be76db5ef45" \
-H "X-NCMB-Timestamp: 2016-03-01T12:34:56.789" \
-H "X-NCMB-Signature: x2Dlg8KCZ7M77kD45ofeCZAJScVcVVl7Xn7SHhE0CF0=" \
-H "Content-Type: application/json" \
https://script.mbaas.api.nifcloud.com/2015-09-01/script/myCoolScript.js?name=foo
GETレスポンス
my name is foo
お探しの内容が見つからなかった場合はユーザーコミュニティ
もご活用ください。(回答保証はいたしかねます)
なお、 Expertプラン以上のお客様はテクニカルサポートにてご質問を承らせて頂きます。
推奨画面サイズ1024×768px以上