本文へジャンプします。

ニフクラ APIリファレンス

クラウド トップ>API>スクリプト>スクリプト実行API

スクリプト:スクリプト実行API

登録されているロジックを実行するAPIです。
スクリプトのStatusがstandbyの場合は実行されません。

リクエスト

Header
ヘッダー名 説明
X-Amz-Target APIバージョン(2015-09-01)とアクション(ExecuteScript)を.(ドット)で連結した文字列
Parameters
パラメータ名 必須 タイプ デフォルト値 説明
Action String - “ExecuteScript”
ScriptIdentifier String - 実行するスクリプト名
Method String - “GET” / “POST” / “PUT” / “DELETE”
Query JSON - スクリプトに渡すクエリストリング
Body JSON - スクリプトに渡すリクエストボディ
Header JSON - スクリプトに渡すリクエストヘッダー

レスポンス

  • 各種、ロジックで実装した一般的な API コールで利用するような任意の文字列が返却される。
  • APIコールのエラーは、HTTP Responseのステータスが200以外になる。
  • スクリプト内でのエラーはResponseStatusとResponseDataに文字列で返される。
パラメーター名 タイプ 説明
ExecuteScriptResponse - ルート
ExecuteScriptResult - 結果
Result - スクリプト実行結果
ScriptIdentifier String スクリプト名
RequestHeaders CDATA リクエストヘッダー
RequestQuery CDATA リクエストクエリストリング
RequestBody CDATA リクエストボディ
ResponseStatus Number レスポンスステータス
ResponseHeaders CDATA レスポンスヘッダー
ResponseData CDATA レスポンスデータ

APIリクエストの例

% curl -X POST "https://script.api.cloud.nifty.com/2015-09-01" \ -H "Content-Type: application/x-www-form-urlencoded" \ -H "X-Amz-Target: 2015-09-01.ExecuteScript" \ -H "Authorization: AWS4-HMAC-SHA256 Credential=XXXXXXXXXXXXXX/20160726/jp-east-1/SCRIPT/aws4_request, SignedHeaders=x-amz-date;x-amz-target, Signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \ -H "X-Amz-Date:20160726T025611Z" \ -d "Method=POST" -d "ScriptIdentifier=sample.js" \ -d "Query={\"name\": \"test\"}" \ -d "Body={\"foo\": \"bar\"}" \ -d "Header={\"X-Custom-Header\": \"headerValue\"}" \ <ExecuteScriptResponse xmlns="http://script.api.cloud.nifty.com/doc/2015-09-01/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-ACL" xsi:type="ExecuteScriptResponse"> <ExecuteScriptResult> <Result> <ScriptIdentifier>sample.js</ScriptIdentifier> <RequestHeaders><![CDATA[{\"X-Custom-Header\":\"headerValue\"}]]></RequestHeaders> <RequestQuery><![CDATA[{\"name\":\"test\"}]></RequestQuery> <RequestBody><![CDATA{\"foo\":\"bar\"}]]></RequestBody> <ResponseStatus>200</ResponseStatus> <ResponseHeaders><![CDATA[{\"Content-Type\":\"application/html+xml\"}]]></ResponseHeaders> <ResponseData><![CDATA[hello]]></ResponseData> </Result> </ExecuteScriptResult> </ExecuteScriptResponse>

推奨画面サイズ 1024×768 以上