テストスキルのエンドポイントの自己署名SSL証明書の設定または取得



テストスキルのエンドポイントの自己署名SSL証明書の設定または取得

HTTPSエンドポイントを使用するスキルでは、スキルマニフェストにSSL証明書情報が必要です。認定を申請する前にスキルをテストする場合、スキルはSelfSigned sslCertificateタイプを使用できます。SSLCertificateSets APIを使用して、スキルマニフェストで提供されるエンドポイントのSSL証明書を設定、取得できます。SSLCertificateSets APIは、sslCertificateTypeが SelfSignedの場合にのみ適用されます。

SSL証明書の種類の詳細については、Skill Manifest:sslCertificateTypeを参照してください。

テスト中に自己署名証明書を使用するようにウェブサービスを設定する方法の詳細については、自己署名証明書を使用するようにウェブサービスを設定するを参照してください。

このAPIのエンドポイントは、https://api.amazonalexa.comです。すべてのAPIリクエストにはAuthorizationヘッダーが必要であり、その値はLogin with Amazonから取得したアクセストークンでなければなりません。

スキルマニフェストにエンドポイントのSSL証明書を設定する

PUT操作で、スキルマニフェストで提供されるエンドポイントのSSL証明書を設定します。以下の例には、NA、EU、FEリージョンが含まれます。

リクエスト

PUT /v1/skills/{skillId}/sslCertificateSets/~latest

パラメーター

フィールド 説明 パラメーターの型 必須
skillId 一意のスキルIDです。 パス ◯

リクエスト本文

{
  "sslCertificate": "{certificateValue}",
  "regions": {
    "NA": {
      "sslCertificate": "{certificateValue}"
    },
    "EU": {
      "sslCertificate": "{certificateValue}"
    },
    "FE": {
      "sslCertificate": "{certificateValue}"
    }
  }
}

パラメーター

フィールド 説明 パラメーター
型		 必須
sslCertificate SSL証明書のデフォルト値です。リージョン値（使用可能な場合）は、指定されたリージョンのこのデフォルト値を上書きします。 文字列 ◯
regions リージョン固有のsslCertificate値を持つリージョンを含むオブジェクトです。 オブジェクトの配列 ✕
regions.<region> 地理的なリージョンを示す2文字のコードです。例：NA、EU、FE 列挙 〇（regionsがある場合）
regions.<region>.sslCertificate デフォルトのSSL証明書値を上書きする、指定されたリージョンのリージョンSSL証明書値です。 列挙 〇（regionsがある場合）

応答

成功すると、APIは204 No Contentを返します。

例外

コードメッセージ
400 不正なリクエストです。
SSL証明書のペイロードが無効です。
401このリソースにアクセスする権限がありません。
404指定したスキルが存在しません。
429リクエストが多すぎます。
500内部サービスエラーです。
503サービスを利用できません。

スキルエンドポイントに関連付けられたSSL証明書を取得する

GET操作で、このスキルに現在関連付けられているSSL証明書セットを取得します。各セットは、リージョンに関連付けられた1つのSSL証明書BLOBと、スキルのデフォルトの証明書で構成されます。

リクエスト

GET /v1/skills/{skillId}/sslCertificateSets/~latest

パラメーター

フィールド 説明 パラメーターの型 必須
skillId 一意のスキルIDです。 パス ◯

応答

成功すると、APIは以下のペイロードとともに200 Successを返します。これには、適用可能なリージョンが含まれます。

{
  "sslCertificate": "{certificateValue}",
  "regions": {
    "NA": {
      "sslCertificate": "{certificateValue}"
    },
    "EU": {
      "sslCertificate": "{certificateValue}"
    },
    "FE": {
      "sslCertificate": "{certificateValue}"
    }
  }
}

パラメーター

フィールド 説明 パラメーター
型		 必須
sslCertificate SSL証明書のデフォルト値です。リージョン値（使用可能な場合）は、指定されたリージョンのこのデフォルト値を上書きします。 文字列 ◯
regions リージョン固有のsslCertificate値を持つリージョンを含むオブジェクトです。 オブジェクトの配列 ✕
regions.<region> 地理的なリージョンを示す2文字のコードです。例：NA、EU、FE 列挙 〇（regionsがある場合）
regions.<region>.sslCertificate デフォルトのSSL証明書値を上書きする、指定されたリージョンのリージョンSSL証明書値です。 列挙 〇（regionsがある場合）

例外

コードメッセージ
401このリソースにアクセスする権限がありません。
404指定したスキルまたはSSL証明書が存在しません。
429リクエストが多すぎます。
500内部サービスエラーです。
503サービスを利用できません。