リクエスト構成

KMS Rest API 1.0を呼び出すには、API Gatewayと Sub Accountの認証が必要です。
API Gatewayによる API呼び出しの詳細は、API Gatewayの説明書(旧ユーザーガイド)をご参照ください。APIリクエストメッセージは、次のように構成されます。

リクエスト構成

専用のヘッダ

x-ncp-apigw-timestamp
x-ncp-iam-access-key
x-ncp-apigw-signature-v1または x-ncp-apigw-signature-v2

API Gateway request signature v1のリクエスト例

Header
  x-ncp-apigw-timestamp:{Timestamp}
  x-ncp-apigw-api-key:{API Gateway API Key}
  x-ncp-iam-access-key:{Sub Account Access Key}
  x-ncp-apigw-signature-v1:{API Gateway Signature}
  Content-Type:application/json
Body
  fieldName: {Base64 Encoded message}
URL
  https://kms.apigw.ntruss.com/keys/v1/{keyTag}/{action}

API Gateway request signature v2のリクエスト例

Header
  x-ncp-apigw-timestamp:{Timestamp}
  x-ncp-iam-access-key:{Sub Account Access Key}
  x-ncp-apigw-signature-v2:{API Gateway Signature}
  Content-Type:application/json
Body
  fieldName: {Base64 Encoded message}
URL
  https://kms.apigw.ntruss.com/keys/v2/{keyTag}/{action}

レスポンス形式

マスターキーで暗号化されて返されるデータは「KMS prefix + 暗号文」で構成されています。KMS prefixは[ncpkms:バージョン情報]で構成されており、これは復号化時に不可欠な情報であるため、任意の削除や操作は禁止されています。KMS prefixが正しくないと、正しく復号化されません。返却されたままの状態で管理することをお勧めします。

 ncpkms:v1:XjsPWPjqPrBi1N2DupSiSbX/ATkGmKA
 --------- -------------------------------
KMS prefix        暗号文

レスポンス例

{
  "code": "SUCCESS",
  "msg": "",
  "data":{
    "ciphertext": "ncpkms:v1:gsYccPMkd/fAtqbKuj2ov4H+EdZC8Qb/b1GPIIN2Z61+yULo"
  }
}

エラーコード