2.10 SSLサブスクリプションの更新
2.10.1 API情報
| テスト環境 | |
|---|---|
| 本番環境 | https://portal.racent.com/ssl/renew |
| リクエスト方式 | POST |
| content-type | multipart/form-data |
| 説明 | このインターフェースはSSLサブスクリプションの更新に使用されます。SSLサブスクリプションのステータスが発行済みで、かつ有効期限が30日以内に切れるサブスクリプションのみ更新が許可されます。 |
2.10.2 パラメータ定義
| パラメータ名 | パラメータタイプ | 必須 | 説明 |
|---|---|---|---|
| api_token | String | Y | 身分証明書。トークンを生成するには、Racentテクニカルサポートにお問い合わせください。 |
| renewId | String | Y | racent証明書ID |
| years | Int | Y | 更新年数(現在は1、2、3、4、5のみ対応)。具体的な製品によって異なります。 |
| refId | String | N | 顧客から提供される一意の顧客注文番号 |
| verificationPic | File | N | 予備の検証資料です。組織検証に使用され、.jpg/.jpeg/.png/.gif/.bmp/.rar/.zip/.pdf形式に対応し、コンテンツサイズは2M以下とします。 |
| domainVerificationPic | File | N | ドメイン検証方式がVERIFY_DOCUMENTの場合、この項目はYとなります。ドメイン管理権限の検証(DCV)に使用されます(現在はCFCAのみ対応)。 |
| params | String | Y | 注文情報。詳細は以下のとおりです |
| csr | String | N | パラメータが空の場合、CSRが生成され、秘密鍵が保存されます。 |
| privateKey | String | N | 秘密鍵。 |
| server | String | N | サーバー。 SSL証明書にのみ関連します。SSL証明書のパラメータはY、その他の種類の製品のパラメータはNです。このパラメータが不要な場合は、デフォルトで「other」を指定してください。 |
| orgCheck | Int | N | 値は0または1です。値が1の場合、提出された組織情報に基づいてアカウント配下のすべての組織を検索し、存在する場合は既存の組織の関連情報を使用し、存在しない場合は新しい組織として保存します。値が0の場合、組織情報を保存しません。 |
| duplicateOrgCheck | Int | N | 値は0または1です。このパラメータは現在Digicert SSL証明書にのみ関連します。以前に検証が完了した組織およびドメイン情報を再利用するかどうかを判定するために使用されます。値が1の場合は再利用し、値が0の場合は新規作成します。デフォルトは1です。 |
| uniqueValue | String | N | Sectigo製品にのみ関連します。販売店が独自に検証値を生成するために使用する1~20文字の文字列(a-z A-Z 0-9)です。 |
| dcvMethod | String | N | 申請ドメインの検証方法を一括設定します。 以下の4つの方法のいずれかを指定する必要があります: EMAIL(メール検証) HTTP_CSR_HASH(ファイル検証) CNAME_CSR_HASH(DNS検証) HTTPS_CSR_HASH(HTTPSファイル検証) VERIFY_DOCUMENT(ドメイン証明書による証明、CFCAのみ対応) CFCAの場合、この項目はYです |
| domainInfo | String | N | ドメイン情報。SSL証明書にのみ関連します。SSL証明書のパラメータはY、その他の種類のパラメータはNです。 CFCAの場合、この項目はNです。 例: [ { "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" } ] 詳細な説明は以下の通りです: |
| dcvMethod | String | N | ドメイン管理権限の検証(DCV)方式。 以下の4つの方式のいずれかを指定する必要があります: EMAIL(メール検証) HTTP_CSR_HASH(ファイル検証) CNAME_CSR_HASH(DNS検証) HTTPS_CSR_HASH(HTTPSファイル検証) |
| dcvEmail | String | N | ドメイン管理権限の検証(DCV)用メールアドレス。検証方式がEMAILの場合、この項目は必須(Y)となります。 |
| domainName | String | N | ドメイン名 |
| organizationInfo | String | N | 企業情報。企業検証が必要な商品を注文する場合、このパラメータはYとなります。 CFCAの場合はこの項目がNとなります。 例は以下の通りです: { "organizationCity": "上海", "organizationName": "某公司", "organizationMobile": "18111111111", "organizationAddress": "上海市路", "organizationCountry": "CN", "organizationPostCode": "401320" }" |
| organizationCity | String | N | 企業の所在する都市。 |
| organizationName | String | N | 企業名。 |
| organizationMobile | String | N | 会社の電話番号。 |
| organizationAddress | String | N | 会社の住所。 |
| organizationCountry | String | N | 会社の所在国(ISO 3166-1規格の2文字コード)。 |
| organizationPostCode | String | N | 会社所在地の郵便番号。 |
| Administrator | String | Y | 管理者情報、連絡先。コード署名、メール署名、ドキュメント署名を申請する場合、このパラメータは申請情報として使用されます。また、csrがNの場合、この情報はcsrの生成情報として使用されます。 CFCAの場合、この項目はNです。 { "job": "総経理室", "city": "上海市", "email": "xx@yy.com", "state": "上海市", "mobile": "18111111111", "address": "上海市", "country": "CN", "lastName": "zhang", "postCode": "401320", "firstName": "nick", "organation": "某公司" }" |
| job | String | Y | 管理者の役職。 |
| city | String | Y | 管理者の所在都市。 |
| String | Y | 管理者のメールアドレス。 | |
| state | String | Y | 管理者が所在する省または州です。 |
| mobile | String | Y | 管理者の連絡先です。 |
| address | String | Y | 管理者の連絡先住所です。 |
| country | String | Y | 管理者の所在国(ISO 3166-1規格の2文字コード)。 |
| lastName | String | Y | 管理者の姓。 |
| postCode | String | Y | 管理者の所在地の郵便番号。 |
| firstName | String | Y | 管理者の名前。 |
| organation | String | Y | 管理者の会社名。 |
| finance | String | SSL証明書関連のみです。 財務担当者情報。管理者情報と同一でも構いません。DVタイプ以外の製品を注文する場合、このパラメータはYとなります。 CFCAの場合はこの項目がNとなります。 { "job": "財務部", "city": "上海市", "email": "xx@yy.com", "state": "上海市", "mobile": "18111111111", "address": "上海市", "country": "CN", "lastName": "zhang", "postCode": "401320", "firstName": "nick", "organation": "某公司" }" | |
| job | String | N | 経理担当者の役職。 |
| city | String | N | 経理担当者の所在都市。 |
| String | N | 経理担当者のメールアドレス。 | |
| state | String | N | 財務担当者が所在する省または州。 |
| mobile | String | N | 財務担当者の連絡先。 |
| address | String | N | 財務担当者の連絡先住所。 |
| country | String | N | 財務担当者の所在国(ISO 3166-1規格の2文字コード)。 |
| lastName | String | N | 財務担当者の姓。 |
| postCode | String | N | 財務担当者の所在地の郵便番号。 |
| firstName | String | N | 経理担当者の名前。 |
| organation | String | N | 経理担当者の所属会社。 |
| tech | String | N | SSL証明書にのみ関連します。 技術担当者情報。注文する製品がdvタイプではない場合、このパラメータはYになります。 CFCAの場合はNです。 { "job": "技術部","city": "上海市", "email": "xx@yy.com", "state": "上海市", "mobile": "18111111111", "address": "上海市", "country": "CN", "lastName": "zhang", "postCode": "401320", "firstName": "nick", "organation": "某公司" }" |
| job | String | N | 技術者の役職。 |
| city | String | N | 技術者が所在する都市。 |
| String | N | 技術者のメールアドレス。 | |
| state | String | N | 技術員の所在する省または州。 |
| mobile | String | N | 技術員の連絡先。 |
| address | String | N | 技術員の連絡先住所。 |
| country | String | N | 技術者の所在国(ISO 3166-1規格の2文字コード)。 |
| lastName | String | N | 技術者の姓。 |
| postCode | String | N | 技術者の所在地の郵便番号。 |
| firstName | String | N | 技術担当者の名前。 |
| organation | String | N | 技術担当者の所属会社。 |
関数の戻り値
| パラメータ名 | パラメータ型 | 必填 | 説明 |
|---|---|---|---|
| code | Int | Y | 戻りステータス。詳細は付録3.1を参照してください |
| errors | Object or String | N | 戻りステータスがエラーの場合の具体的なエラー情報。 |
| data | Object | N | 戻りステータスが成功の場合、このパラメータはYとなります。具体的な内容は以下の通りです: |
| certId | String | N | Racent証明書ID。大切に保管してください。このパラメータはRacentインスタンスの一意のクレデンシャルです。 |
| vendorId | String | N | CA注文番号。 |
| vendorCertId | String | N | CA証明書番号。 |
| DCVfileName | String | N | ファイル検証のファイル名 |
| DCVfileContent | String | N | ファイル検証のファイル内容 |
| DCVdnsHost | String | N | DNS検証のホスト値 |
| DCVdnsValue | String | N | DNS検証のレコード値 |
| DCVdnsType | String | N | DNS検証のレコードタイプ |
| DCVfilePath | String | N | ファイル検証のファイルパス |
| dcvInfo | Object | N | 証明書申請に含まれる各ドメインの検証値が異なる場合、この項目はYとなります 各項目の型はObjectで、各オブジェクト名は申請するドメイン名(例:racent.com)です。各項目の詳細は以下の通りです: |
| DCVfileName | String | N | ファイル検証のファイル内容 |
| DCVfileContent | String | N | ファイル検証のファイル内容 |
| DCVdnsHost | String | N | DNS検証のホスト値 |
| DCVdnsValue | String | N | DNS検証のレコード値 |
| DCVdnsType | String | N | DNS検証のレコードタイプ |
| DCVfilePath | String | N | ファイル検証用ファイルのパス |