2.10 Renew SSL Subscription
2.10.1 API Information
| Test Environment | |
|---|---|
| Production environment | https://portal.racent.com/ssl/renew |
| Request method | POST |
| content-type | multipart/form-data |
| Description | This interface is used to renew SSL subscriptions. Renewal is only allowed for SSL subscriptions that have been issued and will expire within 30 days. |
2.10.2 Parameter Definition
| Parameter Name | Parameter Type | Required | Description |
|---|---|---|---|
| api_token | String | Y | Identity credential. Please contact Racent technical support to generate a token. |
| renewId | String | Y | Racent certificate ID |
| years | Int | Y | Renewal period (currently only supports 1, 2, 3, 4, 5), subject to the specific product. |
| refId | String | N | The unique customer order number provided by the customer |
| verificationPic | File | N | Alternative verification material. Used for organization validation. Supports .jpg/.jpeg/.png/.gif/.bmp/.rar/.zip/.pdf formats, with a maximum file size of 2MB. |
| domainVerificationPic | File | N | This field is Y when the Domain Control Validation method is VERIFY_DOCUMENT. Used for Domain Control Validation (DCV) (currently only supported by CFCA). |
| params | String | Y | Order information, described in detail as follows |
| csr | String | N | If this parameter is left empty, a CSR will be generated for you and the private key will be saved. |
| privateKey | String | N | Private key. |
| server | String | N | Server. Applies only to SSL certificates. The parameter value is Y for SSL certificates, and N for other product types. If this parameter is not required, use "other" by default. |
| orgCheck | Int | N | Value is 0 or 1. When the value is 1, all organizations under your account will be retrieved based on the organization information you submit; if a matching organization exists, the associated information of that existing organization will be used, and if no match exists, the submitted information will be saved as a new organization. When the value is 0, organization information will not be saved. |
| duplicateOrgCheck | Int | N | Value is 0 or 1. This parameter currently applies only to Digicert SSL certificates. It is used to determine whether to reuse previously validated organization and domain information. When the value is 1, the information will be reused. When the value is 0, new records will be created. The default value is 1. |
| uniqueValue | String | N | Only relevant to Sectigo products. 1-20 characters (a-z A-Z 0-9) for distributors to independently generate verification values. |
| dcvMethod | String | N | Set the Domain Control Validation (DCV) method uniformly for certificate requests. 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 for CFCA) This field is required (Y) for CFCA. |
| domainInfo | String | N | Domain information, only relevant to SSL certificates. This parameter is required (Y) for SSL certificates and not required (N) for other certificate types. This field is not required (N) for CFCA. 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" } ] The detailed description is as follows: |
| dcvMethod | String | N | Domain validation 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) |
| dcvEmail | String | N | Domain validation email. This field is required (Y) when the validation method is EMAIL. |
| domainName | String | N | Domain name |
| organizationInfo | String | N | Company information. This parameter is set to Y when ordering products that require enterprise validation. This parameter is N for CFCA. Example: { "organizationCity": "上海", "organizationName": "某公司", "organizationMobile": "18111111111", "organizationAddress": "上海市路", "organizationCountry": "CN", "organizationPostCode": "401320" }" |
| 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 in the ISO 3166-1 standard). |
| organizationPostCode | String | N | Postal code of the company's location. |
| Administrator | String | Y | Administrator information and contact person. This parameter is used as request information when applying for code signing, email signing, or document signing certificates. In addition, if CSR is set to N, this information will be used as CSR generation information. This field is N for CFCA. { "job": "General Manager Office", "city": "Shanghai", "email": "xx@yy.com", "state": "Shanghai", "mobile": "18111111111", "address": "Shanghai", "country": "CN", "lastName": "zhang", "postCode": "401320", "firstName": "nick", "organation": "Certain Company" }" |
| job | String | Y | Position of the administrator. |
| city | String | Y | City where the administrator is located. |
| String | Y | Email address of the administrator. | |
| state | String | Y | Province or state where the administrator is located. |
| mobile | String | Y | Contact phone number of the administrator. |
| address | String | Y | Contact address of the administrator. |
| country | String | Y | The country of the administrator (two-letter code as specified in the ISO 3166-1 standard). |
| lastName | String | Y | The last name of the administrator. |
| postCode | String | Y | The postal code of the administrator's location. |
| firstName | String | Y | Administrator's first name. |
| organation | String | Y | Administrator's company name. |
| finance | String | Only relevant for SSL certificates. Financial contact information. This can be the same as the administrator information. This parameter is required (Y) when the ordered product is not a DV type. This field is not required (N) for CFCA. { "job": "Finance Department", "city": "Shanghai", "email": "xx@yy.com", "state": "Shanghai", "mobile": "18111111111", "address": "Shanghai", "country": "CN", "lastName": "zhang", "postCode": "401320", "firstName": "nick", "organation": "某公司" }" | |
| job | String | N | Finance officer position. |
| city | String | N | City where the finance officer is located. |
| String | N | Email address of the finance officer. | |
| state | String | N | Province or state where the financial officer is located. |
| mobile | String | N | Contact information of the financial officer. |
| address | String | N | Contact address of the financial officer. |
| country | String | N | Country of the finance officer (two-letter code defined in ISO 3166-1 standard). |
| lastName | String | N | Last name of the finance officer. |
| postCode | String | N | Postal code of the finance officer's location. |
| firstName | String | N | Name of the finance officer. |
| organation | String | N | Company of the finance officer. |
| tech | String | N | Relevant only to SSL certificates. Information of the technical contact. This parameter is Y when the ordered product is not of DV type. This parameter is N for CFCA. { "job": "Technical Department","city": "Shanghai", "email": "xx@yy.com", "state": "Shanghai", "mobile": "18111111111", "address": "Shanghai", "country": "CN", "lastName": "zhang", "postCode": "401320", "firstName": "nick", "organation": "A Company" }" |
| job | String | N | Technician's job title. |
| city | String | N | City where the technician is located. |
| String | N | Technician's email address. | |
| state | String | N | Province or state where the technician is located. |
| mobile | String | N | Contact information of the technician. |
| address | String | N | Contact address of the technician. |
| country | String | N | Country where the technician is located (two-letter code per ISO 3166-1 standard). |
| lastName | String | N | Last name of the technician. |
| postCode | String | N | Postal code of the technician's location. |
| firstName | String | N | Name of the technician. |
| organation | String | N | Company of the technician. |
Function Response
| Parameter | Type | Required | Description |
|---|---|---|---|
| code | Int | Y | Return status. For detailed explanations, see Appendix 3.1. |
| errors | Object or String | N | Specific error message when the return status indicates an error. |
| data | Object | N | This parameter is present (Y) when the return status indicates success. Specific descriptions are as follows: |
| certId | String | N | Racent certificate ID. Please keep it properly, as 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 file name |
| DCVfileContent | String | N | File validation file content |
| DCVdnsHost | String | N | DNS validation host value |
| DCVdnsValue | String | N | DNS validation record value |
| DCVdnsType | String | N | DNS validation record type |
| DCVfilePath | String | N | File validation file path |
| dcvInfo | Object | N | This item is Y when the validation value of each domain in the certificate request is different Each item is of type Object, and the object name of each item is the requested domain, for example: racent.com. Details of each item are as follows: |
| DCVfileName | String | N | File validation file content |
| DCVfileContent | String | N | File validation file content |
| DCVdnsHost | String | N | DNS validation host value |
| DCVdnsValue | String | N | DNS validation record value |
| DCVdnsType | String | N | DNS validation record type |
| DCVfilePath | String | N | File path for file-based Domain Control Validation (DCV) |