2.21 申請資料の修正
2.21.1 API情報
| テスト環境 | |
|---|---|
| 本番環境 | https://portal.racent.com/ssl/alter |
| リクエスト方式 | POST |
| content-type | multipart/form-data |
| 説明 | このインターフェースはCFCA証明書申請が失敗した場合に、申請資料を修正するためにのみ使用されます。 |
2.21.2 パラメータ定義
| パラメータ名 | パラメータタイプ | 必須 | 説明 |
|---|---|---|---|
| api_token | String | Y | 認証資格情報です。トークンを生成するにはRacentテクニカルサポートにお問い合わせください。 |
| certId | String | Y | racent証明書ID |
| refId | String | N | お客様が提供する一意の顧客注文番号 |
| verificationPic | File | N | 予備の検証資料です。組織検証に使用します。.jpg/.jpeg/.png/.gif/.bmp/.rar/.zip形式に対応し、コンテンツサイズは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です。 |
| 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です。 標準ドメインの合計数とワイルドカードドメインの合計数は、それぞれ購入した標準ドメインの合計数とワイルドカードドメインの合計数を超えることはできません。 例: [ { "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 | ドメイン検証方式。 以下の4つの方式のいずれかである必要があります: EMAIL(メール検証) HTTP_CSR_HASH(ファイル検証) CNAME_CSR_HASH(DNS検証) HTTPS_CSR_HASH(httpsファイル検証) 上位のdcvMethodが存在しない場合、この項目はYです。 上位のdcvMethodが存在し、この項目も存在する場合、上位のdcvMethodが優先して使用されます。 |
| dcvEmail | String | N | ドメイン検証用メールアドレス。 この項目がNの場合、デフォルトは以下の通りです racent.com : admin@racent.com www.racent.com : admin@racent.com *.racent.com : admin@racent.com |
| domainName | String | N | ドメイン名 |
| organizationInfo | String | N | 企業情報。企業認証が必要な製品を注文する場合、このパラメータはYとなります。記述例は以下の通りです: { "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 | 会社所在地の郵便番号。 |
| organizationRegNumbe | String | N | 会社の証明書番号。CFCAの場合はこの項目がYとなります。 |
| idType | String | N | 会社証明書の種類です。CFCAの場合はこの項目がYとなります。 値は以下の通りです: TYDMZ:統一社会信用コード OTHERS:その他 |
| Administrator | String | Y | 管理者情報、連絡先です。コード署名、メール署名、ドキュメント署名を申請する場合、このパラメータは申請情報として使用されます。また、csrがNの場合、この情報はcsrの生成情報として使用されます。 { "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 | 管理者の会社名です。 |
| idType | String | N | 証明書タイプです。CFCAの場合、この項目はYとなります。 値は以下の通りです: SFZ:身分証明書 HZ:パスポート |
| idNumber | String | N | 証明書番号です。CFCAの場合、この項目はYとなります。 |
| finance | String | SSL証明書にのみ関連します。 財務担当者情報。管理者情報と同一でも構いません。注文する製品がDVタイプでない場合、このパラメータは必須(Y)です。 { "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 | 経理担当者の所属会社です。 |
| idType | String | N | 証明書の種類。CFCAの場合、この項目はYとなります。 値は以下の通りです: SFZ:居民身分証 HZ:パスポート |
| idNumber | String | N | 証明書番号。CFCAの場合、この項目はYとなります。 |
| tech | String | N | SSL証明書にのみ関連します。 技術担当者情報。注文する製品がdvタイプでない場合、このパラメータはYとなります。 { "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 | 技術者が所属する会社。 |
| idType | String | N | 身分証明書の種類。CFCAの場合、この項目はYとなります。 指定可能な値は以下の通りです: SFZ:居民身分証 HZ:パスポート |
| idNumber | String | N | 身分証明書の番号。CFCAの場合、この項目はYとなります。 |
関数の戻り値
| 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 | ファイル検証用ファイルのパス |
| failReason | Object | N | RacentがCAへの証明書申請に失敗し、かつ失敗原因を明確に特定できた場合に、この項目が返されます。 |
| dataReasons | Array | N | データ関連の原因 |
| key | String | N | 項目 |
| reason | String | N | 原因 |
| sysReason | String | N | システム上の原因 |