REST API リファレンス

共通ドキュメント

スクリプト実行

スクリプト実行APIについて

登録したスクリプトを実行します。
レスポンスでは、登録したスクリプトの返り値がレスポンスとして返却されます。

基本仕様

スクリプト REST APIを利用する際の仕様は以下のとおりです。

名前 説明
APIのエンドポイント script.mbaas.api.nifcloud.com
APIのバージョン 2015-09-01
APIパス /script/スクリプト名 (.js で終わるファイル名)
メソッド GET/POST/PUT/DELETE
使用するプロトコル HTTPS
文字コード UTF-8
  • 旧ドメインAPIの script.mb.api.cloud.nifty.com は2019年9月廃止予定です。

リクエスト

ヘッダー

一部を除き、一般的な API コールで利用するような任意のヘッダーが指定可能です。
以下のヘッダーは認証に必要であるため、これらを上書きするヘッダーは使用できません。

ヘッダー名 説明
host アクセス先ホスト
X-NCMB-Application-Key アプリケーションキー
X-NCMB-Signature シグネチャ
X-NCMB-Timestamp タイムスタンプ
X-NCMB-Apps-Session-Token アプリセッショントークン
ボディ

各種、一般的な API コールで利用するような任意の文字列が指定可能です。

クエリストリング

各種、一般的な API コールで利用するような任意の文字列が指定可能です。

レスポンス

HTTPステータス
ステータスコード 内容
200 正常終了
404 未検出
500 Script内部エラー
ヘッダー

登録したスクリプトのレスポンスヘッダー

コンテント

登録したスクリプトのレスポンスボディ

リクエストサンプル

サンプルスクリプト

以下のような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