本文へジャンプします。

ニフティクラウド APIリファレンス

クラウド トップ>API>ESS>共通リクエスト、レスポンス

ESS:共通リクエスト、レスポンス

概要

ESS APIはREST APIです。
REST APIを使用する際の共通リクエストパラメーター、レスポンスを説明します。

リクエストパラメーター

要素名 説明 形式 シグネチャーバージョンごとの必須対応
4(ヘッダ) 4(パラメーター)
Timestamp APIへのリクエスト日時
形式 : YYYY-MM-DDThh:mm:ssZ
パラメーター    
Date リクエスト日時、シグネチャー算出に使用 ヘッダー    
X-Nifty-Date | X-Amz-Date リクエスト日時、シグネチャー算出に使用 ヘッダー
パラメーター
Authorization 算出されたシグネチャーから生成した認証文字列 ヘッダー  
X-Nifty-Algorithm | X-Amzn-Algorithm シグネチャーの暗号方式
指定可能な値 : AWS4-HMAC-SHA256 | NIFTY4-HMAC-SHA256
パラメーター  
X-Nifty-Credential | X-Amz-Credential アクセスキーID/日付/
リージョン名/サービス名/固定文字の順
パラメーター  
X-Nifty-Signature | X-Amz-Signature リクエスト時の認証用文字列 パラメーター  
X-Nifty-SignedHeaders | X-Amz-SignedHeaders 認証用文字列作成時に利用されたヘッダー名のリスト(;区切り) パラメーター  
  • ※注1シグネチャーの生成については「API:シグネチャー」をご参照ください。
  • ※注2「X-Nifty-Date」または「X-Amzn-Date」とDateヘッダーが指定された場合、Dateヘッダーが無視されます。
  • ※注3「X-Nifty-***」系、「X-Amz-***」系はどちらかに統一して指定する必要があります。

レスポンス

要素名 説明 備考
ResponseMetadata 共通メタ情報ルート  
RequestId リクエストID  

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