本文へジャンプします。

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

REST共通パラメーターと認証方式

共通パラメーター

RESTでリクエストを行う場合、リクエスト毎に以下の共通パラメーターを常に付加する必要があります。
(後述のIF仕様では、リクエストサンプルに”CommonParams”として記述しています。)

パラメーター 説明 必須 サンプル値
AccessKeyId コントロールパネルより取得したAccessKey  
SignatureVersion

認証バージョン
指定可能な値 : 0 | 1 | 2

  • ※指定値により必須パラメーターが変わります。
    [SignatureVersion=0]
    必須 : Timestamp, AccessKeyId, Signature
    [SignatureVersion=1]
    必須 : AccessKeyId, Signature
    [SignatureVersion=2]
    必須 : AccessKeyId, SignatureMethod, Signature
2
Signature 認証文字列
※生成ロジックは後述
 
Version 実行するAPIのバージョン   1.7
Timestamp APIへのリクエスト日時
形式 : YYYY-MM-DDThh:mm:ssZ
  2011-02-01T10:01:55Z
SignatureMethod APIの認証ロジック
指定可能な値 : HmacSHA1 | HmacSHA256
  HmacSHA1
  • ※リクエスト時は、共通パラメーター以外とあわせて以下のパラメーターを付加する必要があります。
    • 実行するAPI名(Action=[API名])
    • APIのパラメーター
  • ※Signature(認証文字列)は、SignatureVersionパラメーターの値によって、生成ロジックが異なります。
    以下を参考にしてください。
SignatureVersion = 0 の場合

StringToSign = Action値 + Timestamp値
Signature = Base64( HmacSHA1 (SecretAccessKey, StringToSign) )

例:StringToSign = DescribeImages2010-10-14T12:23:13.406Z
SignatureVersion = 1 の場合
StringToSign = パラメーター名1+ パラメーター値1 + パラメーター名2 + … + パラメーター値n
Signature = Base64( HmacSHA1 (SecretAccessKey, StringToSign) )

例:StringToSign = ActionDescribeImagesAccessKeyIdAKIAIZXJ5ZDCD7NZ73XQImageId.110021
SignatureVersion1Timestamp2010-10-14T12:20:09.343ZVersion1.7
SignatureVersion = 2 の場合

StringToSign = HTTPリクエストメソッド + \n
endpointのドメイン部分 + \n
URLエンコードしたendpointのパス部分 + \n
リクエスト文字列(*)
Signature = Base64(SignatureMethod によるハッシュ(SecretAccessKey, StringToSign) )

(*)リクエスト文字列:

  1. パラメーター名をUTF-8の自然順序でソートする
  2. パラメーター名と値をURLエンコードする
  3. パラメーター名と値をイコール(“=”)で連結する
  4. パラメーター名と値のペアを、アンパサント(“&”)で連結する

例:StringToSign = GET¥n
cp.cloud.nifty.com¥n
/api/services/NiftyCloud/¥n
AccessKeyId=AKIAIZXJ5ZDCD7NZ73XQ&Action=DescribeImages&SignatureMethod=HmacSHA256&SignatureVersion=2

認証方式

APIサーバーは、Signatureを前述の方法で同様に生成し、リクエストパラメーターとして受け取ったSignatureと文字列比較を行います。

文字列が一致すると、認証文字列は正しいと判定し、Actionパラメーターで指定されたAPIの処理を実行します。

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフティクラウド公式フェイスブックページ

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