2.3 証明書申請ステータスの取得
2.3.1 API情報
| テスト環境 | |
|---|---|
| 本番環境 | https://portal.racent.com/ssl/collect |
| リクエスト方式 | POST |
| content-type | multipart/form-data |
| 説明 | このインターフェースは、注文した証明書のステータス取得、証明書の取得、検証情報の取得に使用されます。 |
2.3.2 パラメータ定義
| パラメータ名 | パラメータ型 | 必須 | 説明 |
|---|---|---|---|
| certId | String | Y | racent証明書ID |
| api_token | String | Y | 認証情報。トークンの生成についてはRacentテクニカルサポートまでお問い合わせください。 |
関数戻り値
| パラメータ名 | パラメータ型 | 必須 | 説明 |
|---|---|---|---|
| code | int | Y | 戻りステータス。詳細は付録3.1を参照してください。 |
| status | String | Y | 注文ステータス: PENDING:申請中 COMPLETE:申請成功 CANCELLED:キャンセル済み REISSUED:再発行済み FAILED:申請失敗 RENEWED:更新済み REVOKED:失効済み |
| certStatus | String | Y | 証明書ステータス: PENDING:申請中 COMPLETE:申請成功 CANCELLED:キャンセル済み REISSUED:再発行済み FAILED:申請失敗 RENEWED:更新済み REVOKED:失効済み |
| data | Object | N | 返却データ、以下は具体的な詳細です |
| failReason | Object | N | ステータスがFAILEDの場合、このパラメータはYとなり、失敗理由を示します |
| dataReasons | Array | N | データ上の理由 |
| key | String | N | 項目 |
| reason | String | N | 理由 |
| sysReason | String | N | システム上の理由 |
| beginDate | String | N | ステータスがCOMPLETEの場合、このパラメータはYとなり、証明書の開始時間を示します |
| endDate | String | N | ステータスがCOMPLETEの場合、このパラメータはYとなり、証明書の終了時間を示します |
| certificate | String | N | ステータスがCOMPLETEの場合、このパラメータはYとなり、pem形式の証明書を示します |
| caCertificate | String | N | ステータスがCOMPLETEの場合、このパラメータはYとなり、PEM形式の中間証明書です。 |
| jks | String | N | ステータスがCOMPLETEで、かつRacentに正しい秘密鍵情報が存在する場合、このパラメータはYとなり、JKS証明書内容のbase64エンコードです。 |
| jksPass | String | N | ステータスがCOMPLETEで、かつRacentに正しい秘密鍵情報が存在する場合、このパラメータはYとなり、JKS証明書のパスワードです。 |
| pkcs12 | String | N | ステータスがCOMPLETEで、かつRacentに正しい秘密鍵情報が存在する場合、このパラメータはYとなり、PKCS12証明書内容のbase64エンコードです。 |
| pkcsPass | String | N | ステータスがCOMPLETEで、かつRacentに正しい秘密鍵情報が存在する場合、このパラメータはYとなり、PKCS12証明書のパスワードです。 |
| privateKey | String | N | ステータスがCOMPLETEで、かつRacentに正しい秘密鍵情報が存在する場合、このパラメータはYとなり、秘密鍵情報です。 |
| rsaPrivateKey | String | N | RSA形式の秘密鍵です。ステータスがCOMPLETEで、かつRacentに正しい秘密鍵情報が存在する場合、このパラメータはYとなり、秘密鍵情報です。 |
| replaceCertId | String | N | ステータスがREISSUEDの場合、このパラメータはYとなります。 再発行後のRacent証明書IDです。 |
| oldCertId | String | N | 申請する証明書が再発行証明書である場合、このパラメータはYとなります。 元のRacent証明書IDです。 |
| vendorId | String | N | CA注文番号 |
| vendorCertId | String | N | CA証明書番号(sectigo注文番号) |
| DCVfileName | String | N | ドメインファイル検証、ファイル名 |
| DCVfileContent | String | N | ファイル検証、ファイル内容 |
| DCVdnsHost | String | N | DNS検証、host |
| DCVdnsValue | String | N | DNS検証 value |
| DCVdnsType | String | N | DNS検証 type |
| dcvInfo | Object | N | 証明書申請に含まれる各ドメインの検証値が異なる場合、この項目はYとなります 各項目の型はObjectで、各オブジェクト名は申請するドメイン名(例:racent.com)です。各項目の詳細は以下の通りです: |
| DCVfileName | String | N | ドメインファイル検証、ファイル名 |
| DCVfileContent | String | いいえ | ファイル検証、ファイルの内容 |
| DCVdnsHost | String | いいえ | DNS検証、host |
| DCVdnsValue | String | いいえ | DNS検証 value |
| DCVdnsType | String | いいえ | DNS検証 type |
| DCVfilePath | String | いいえ | ファイル検証のファイルパス |
| dcvList | Array | いいえ | ドメイン検証リスト。各項目の型はObjectで、詳細は以下の通りです: |
| domainName | String | いいえ | ドメイン名 |
| dcvMethod | String | いいえ | ドメイン管理権限の検証(DCV)の方法 |
| dcvEmail | String | いいえ | ドメイン検証用メールアドレス |
| is_verify | String | N | 検証済みのパラメータ値は「verified」で、未検証の場合はパラメータがありません |
| application | Object | N | 注文送信ステータス |
| status | String | N | パラメータは以下のいずれかの値です: notdone:未完了 done:完了 ongoing:進行中 |
| dcv | Object | N | ドメイン検証ステータス |
| status | String | N | パラメータは以下のいずれかの値です: notdone:未完了 done:完了 ongoing:進行中 |
| ov | Object | N | 組織検証ステータス |
| status | String | N | パラメータは以下のいずれかの値です: notdone:未完了 done:完了 ongoing:進行中 |
| issued | Object | N | 発行ステータス |
| status | String | N | パラメータは以下のいずれかの値です: notdone:未完了 done:完了 ongoing:進行中 |
| applyParams | Object | N | 申請パラメータ。詳細は申請インターフェース(place)のリクエストパラメータを参照してください |
| csr | String | N | csr |
| Administrator | Object | N | 管理者情報 |
| 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 | Object | N | 技術担当者情報。具体的な項目は管理者情報と同じです |
| finance | Object | N | 財務担当者情報。具体的な項目は管理者情報と同じです |
| organizationInfo | Object | N | 会社情報 |
| organizationCity | String | N | 市区町村 |
| organizationName | String | N | 名称 |
| organizationMobile | String | N | 電話番号 |
| organizationAddress | String | N | 住所 |
| organizationCountry | String | N | 国 |
| organizationPostCode | String | N | 郵便番号 |
| organizationRegNumbe | String | N | 会社証明書番号。CFCAの場合はこの項目がYとなります。 |
| idType | String | N | 会社証明書の種類。CFCAの場合はこの項目がYとなります。 値は以下の通りです: TYDMZ:統一社会信用コード OTHERS:その他 |
| errors | Object or String | N | 返却ステータスがエラーの場合、詳細なエラーメッセージを示します。 |