2.2 証明書の注文
2.2.1 インターフェースの説明
| テスト環境 | |
|---|---|
| 本番環境 | https://portal.racent.com/ssl/place |
| リクエスト方式 | POST |
| content-type | multipart/form-data |
| 説明 | このインターフェースは証明書を注文するために使用されます。 |
2.2.2 パラメータ定義
| パラメータ名 | パラメータタイプ | 必須 | 説明 |
|---|---|---|---|
| api_token | String | Y | 認証情報です。tokenの生成についてはRacentテクニカルサポートにお問い合わせください。 |
| productCode | String | Y | プロダクトコード、プロダクトコードの取得(2.7を参照) |
| 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です。 |
| needFree | Int | N | 値は1または2です。値が1の場合、FQDNが付与され、同時にwww.domainに対してもdomainが付与されます。値が2の場合、付与されません。 |
| 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です。 例: [ { "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になります。 |
| 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インスタンスの一意のクレデンシャルです。 |
| failReason | Object | N | Racentが認証局(CA)に証明書を申請して失敗し、失敗理由が明確に特定できた場合にこの項目が返されます。 |
| dataReasons | Array | N | データ理由 |
| key | String | N | 項目 |
| reason | String | N | 理由 |
| sysReason | String | N | システム原因 |
| 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 | ファイル検証ファイルのパス |