メインコンテンツまでスキップ

2.12 SSL購読情報の置換

2.12.1 API情報

テスト環境
本番環境https://portal.racent.com/ssl/replace
リクエストメソッドPOST
content-typemultipart/form-data
説明このインターフェースはSSL購読情報の置き換えに使用されます。SSL証明書関連のみ対象です。SSL購読ステータスが発行済みの場合に限り、SSL購読情報の置き換えが許可されます。

2.12.2 パラメータ定義

パラメータ名パラメータタイプ必須説明
api_tokenStringY認証情報です。tokenの生成についてはRacentテクニカルサポートまでお問い合わせください。
certIdStringYracent証明書id
refIdStringNお客様から提供される一意の受注番号
domainVerificationPicFileNドメイン検証方式がVERIFY_DOCUMENTの場合、この項目は必須(Y)です。ドメイン管理権限の検証(DCV)に使用されます(現在はCFCAのみ対応)。
paramsStringY置換情報であり、詳細は以下の通りです
csrStringY注:CSR情報内のドメインは、元のSSL購読のCSRに含まれるドメインと一致している必要があります。
uniqueValueStringNSectigo製品のみに関連します。販売店が独自に検証値を生成するための1~20文字(a-z A-Z 0-9)の文字列です。
dcvMethodStringN申請ドメインの検証方式を一括設定します。
以下の4つの方式のいずれかを指定する必要があります:
EMAIL(メール検証)
HTTP_CSR_HASH(ファイル検証)
CNAME_CSR_HASH(DNS検証)
HTTPS_CSR_HASH(HTTPSファイル検証)
VERIFY_DOCUMENT(ドメイン証明書による証明、CFCAのみ対応)
CFCAの場合はこの項目が必須(Y)です
domainInfoStringYドメイン情報。
例:
[
{ "dcvEmail": "admin@xxx.com",
"dcvMethod": "EMAIL",
"domainName": "www.xxx.com"
},
{
"dcvEmail": "admin@aaa.com",
"dcvMethod": "EMAIL",
"domainName": "aaa.com"
},
"dcvEmail": "admin@racent.com",
"dcvMethod": "EMAIL",
"domainName": "racent.com"
}
]
詳細は以下の説明をご参照ください。
dcvMethodStringYドメイン検証方式。
以下の4つの方式のいずれかを指定する必要があります:
EMAIL(メール検証)
HTTP_CSR_HASH(ファイル検証)
CNAME_CSR_HASH(DNS検証)
HTTPS_CSR_HASH(httpsファイル検証)
上位のdcvMethodが存在しない場合、この項目は必須(Y)です。
上位のdcvMethodが存在し、この項目も指定されている場合は、上位のdcvMethodが優先的に使用されます。
dcvEmailStringNドメイン検証用メールアドレス。
この項目がN(任意)の場合のデフォルト値は以下の通りです
racent.com : admin@racent.com
www.racent.com : admin@racent.com
*.racent.com : admin@racent.com
domainNameStringYドメイン名
organizationInfoStringN企業情報を変更する必要がある場合、このパラメータは必須(Y)となります。
organizationCityStringN会社の所在都市。
organizationNameStringN会社名。
organizationMobileStringN会社の電話番号。
organizationAddressStringN会社の住所。
organizationCountryStringN会社の所在国(ISO 3166-1規格の2文字コード)。
organizationPostCodeStringN会社所在地の郵便番号。

関数の戻り値

パラメータ名パラメータタイプ必須説明
codeIntY返却ステータス。詳細は付録3.1を参照してください
errorsObject or StringN返却ステータスがエラーの場合の具体的なエラー情報
dataObjectN返却ステータスが成功の場合、このパラメータはYとなります。具体的な説明は以下の通りです:
certIdStringNRacent証明書ID。Racentインスタンスの一意の認証情報となるため、大切に保管してください。
vendorIdStringNCA注文番号
vendorCertIdStringNCA証明書番号
DCVfileNameStringNファイル検証用ファイル名
DCVfileContentStringNファイル検証用ファイルの内容
DCVdnsHostStringNDNS検証ホスト値
DCVdnsValueStringNDNS検証レコード値
DCVdnsTypeStringNDNS検証レコードタイプ
DCVfilePathStringNファイル検証用ファイルのパス
dcvInfoObjectN証明書申請に含まれる各ドメインの検証値が異なる場合、この項目はYとなります
各項目の型はObjectで、項目名は申請するドメイン名(例:racent.com)です。各項目の詳細は以下の通りです:
DCVfileNameStringNファイル検証用ファイル名
DCVfileContentStringNファイル検証用ファイルの内容
DCVdnsHostStringNDNS検証のホスト値
DCVdnsValueStringNDNS検証のレコード値
DCVdnsTypeStringNDNS検証のレコードタイプ
DCVfilePathStringNファイル検証用ファイルのパス