2.12 Replace SSL Subscription Information
2.12.1 API Information
| Test Environment | |
|---|---|
| Production Environment | https://portal.racent.com/ssl/replace |
| Request Method | POST |
| content-type | multipart/form-data |
| Description | This interface is used to replace SSL subscription information. It is only related to SSL certificates. Replacing SSL subscription information is only allowed when the SSL subscription status is issued. |
2.12.2 Parameter Definition
| Parameter Name | Parameter Type | Required | Description |
|---|---|---|---|
| api_token | String | Y | Identity credential. Please contact Racent technical support to generate the token. |
| certId | String | Y | racent certificate ID |
| refId | String | N | The unique customer order number provided by the customer. |
| domainVerificationPic | File | N | This field is required (Y) when the domain validation method is VERIFY_DOCUMENT. It is used for Domain Control Validation (DCV) (currently only supported by CFCA). |
| params | String | Y | Replacement information, described in detail as follows. |
| csr | String | Y | Note: The domain name in the CSR information must be consistent with the domain name in the CSR from the original SSL subscription. |
| uniqueValue | String | N | Relevant only for Sectigo products. 1–20 characters (a-z, A-Z, 0-9) used by resellers to independently generate validation values. |
| dcvMethod | String | N | Set the application domain validation method uniformly. Must be one of the following four methods: EMAIL (email validation) HTTP_CSR_HASH (file validation) CNAME_CSR_HASH (DNS validation) HTTPS_CSR_HASH (HTTPS file validation) VERIFY_DOCUMENT (domain certificate proof, only supported by CFCA) This field is required (Y) for CFCA. |
| domainInfo | String | Y | Domain information. Example: [ { "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" } ] Detailed description as follows: |
| dcvMethod | String | Y | Domain Control Validation (DCV) method. Must be one of the following four methods: EMAIL(Email validation) HTTP_CSR_HASH(File validation) CNAME_CSR_HASH(DNS validation) HTTPS_CSR_HASH(HTTPS file validation) When the upper-level dcvMethod does not exist, this field is required (Y). When the upper-level dcvMethod exists and this field is also set, the upper-level dcvMethod will take precedence. |
| dcvEmail | String | N | Domain Control Validation (DCV) email address. When this field is set to N, the default values are as follows racent.com : admin@racent.com www.racent.com : admin@racent.com *.racent.com : admin@racent.com |
| domainName | String | Y | Domain name |
| organizationInfo | String | N | This parameter is required (Y) when you need to change the organization information. |
| organizationCity | String | N | City where the company is located. |
| organizationName | String | N | Company name. |
| organizationMobile | String | N | Company phone number. |
| organizationAddress | String | N | Company address. |
| organizationCountry | String | N | Country where the company is located (two-letter code as defined in the ISO 3166-1 standard). |
| organizationPostCode | String | N | Postal code of the company's location. |
Function Response
| Parameter Name | Parameter Type | Required | Description |
|---|---|---|---|
| code | Int | Y | Return status; for detailed explanations, see Appendix 3.1 |
| errors | Object or String | N | Specific error information when the return status is an error. |
| data | Object | N | This parameter is present (Y) when the return status is success. Detailed description is as follows: |
| certId | String | N | Racent certificate ID. Please keep it properly; this parameter is the unique credential for the Racent instance. |
| vendorId | String | N | CA order number. |
| vendorCertId | String | N | CA certificate number. |
| DCVfileName | String | N | File validation filename |
| DCVfileContent | String | N | Content of the file validation file |
| DCVdnsHost | String | N | DNS validation host value |
| DCVdnsValue | String | N | DNS validation record value |
| DCVdnsType | String | N | DNS validation record type |
| DCVfilePath | String | N | Path of the file validation file |
| dcvInfo | Object | N | When the validation value for each domain name in the certificate request is different, this field is Y. Each entry is of Object type, with the requested domain name as the object name, for example: racent.com. Details of each entry are as follows: |
| DCVfileName | String | N | Content of the file for file-based validation |
| DCVfileContent | String | N | Content of the file for file-based validation |
| DCVdnsHost | String | N | Host value for DNS validation |
| DCVdnsValue | String | N | Record value for DNS validation |
| DCVdnsType | String | N | Record type for DNS validation |
| DCVfilePath | String | N | File path for file-based validation |