Solutions
NicSRS industry solutions tailored to meet the specific needs of corporations, accelerate cloud applications construction.
Web Security Support
NicSRS API
POST
https://portal.nicsrs.com/ssl/place
Use this endpoint to order certificates. If the order request has
been successfully completed, it will return to the correct order information.
If not, it will return an error code.
Fields explanation:
▪ R – Required
▪ O – Optional
Name |
Type |
Req/Opt |
Description |
api_token |
String |
R |
User token. To get token, please
contact NicSRS technical support. |
productCode |
String |
R |
Product code. Please see the endpoint of Product List. |
years |
Int |
R |
The validity period of the
certificate order. The value is from 1-6 years depending on the specific
products of nicsrs.com. |
refId |
String |
The unique customer order ID
provided by reseller. |
|
params |
Json |
R |
Order details are as follows: |
-csr |
String |
O |
Certificate Signing Request (CSR). ▪ Use openssl to generate Base-64 encoded CSR.
Note: please keep your private key properly. ▪ If requested parameters are N/A,
CSR will be generated and paired private key also be saved. |
-privateKey |
String |
O |
The private key of this certificate. |
-server |
String |
O |
The server platform
where SSL certificates are deployed. Note: This is required
only for SSL certificates. Please use one of theseserver platforms. |
-uniqueValue |
String |
O |
Only relevant for SSL
certificates. Value only for
Sectigo products (Please set the value within 1-20 characters from a-z, A-Z,
0-9.) |
-domainInfo |
Json |
O |
Only relevant for SSL
certificates. This is required only for SSL certificates. Domain name
information. A standard certificate includes only a piece of information. e.g.
[ {
"dcvEmail": "[email protected]",
"dcvMethod": "EMAIL",
"domainName": "www.xxx.com" }, {
"dcvEmail": "[email protected]",
"dcvMethod": "EMAIL",
"domainName": "aaa.com" }, {
"dcvEmail": "[email protected]",
"dcvMethod": "EMAIL",
"domainName": "nicsrs.com" } ] More parameters are
as follows. |
--dcvMethod |
String |
R |
Only relevant for SSL
certificates. Domain control validation
(DCV) methods. When performing domain control validation, you must choose one
of four methods below. EMAIL (Approver Email Method) HTTP_CSR_HASH (HTTP Based Validation Method) CNAME_CSR_HASH (DNS Based Validation Method) HTTPS_CSR_HASH (https Based Validation Method) |
--dcvEmail |
String |
O |
Only relevant for SSL certificates. Only required for Sectigo SSL
certificates and the Email method of domain control validation. These are five
different types of emails addresses that Sectigo can only send the DCV email.
Use one of five addresses below. admin@ administrator@ postmaster@ webmaster@ hostmaster@ |
--domainName |
String |
R |
Only relevant for SSL
certificates. The domain name for
an order. |
-organizationInfo |
Json |
O |
Only relevant for SSL
certificates. Organization information that applies for
certificates. Note: Only required for OV/ EV
certificates. |
--organizationCity |
String |
O |
Only relevant for SSL certificates. The city where organization is
located. Note: Only required for OV/ EV
certificates. |
--organizationName |
String |
O |
Only relevant for SSL
certificates. Organization name. Note: Only required for OV/ EV
certificates. |
--organizationMobile |
String |
O |
Only relevant for SSL
certificates. Organization phone number that can be searched in the
third authority. Note: Only required for OV/ EV
certificates. |
--organizationAddress |
String |
O |
Only relevant for SSL
certificates. Organization address. Note: Only required for OV/ EV
certificates. |
--organizationCountry |
String |
O |
Only relevant for SSL certificates. Organization Country Name. See Appendix - Country codes. Note: Only required for OV/ EV
certificates. |
--organizationPostCode |
String |
O |
Only relevant for SSL
certificates. Organization Postal Code. Note: Only required for OV/ EV
certificates. |
-Administrator |
Json |
R |
Details about the administrator contact on the order. If applying for an SSL certificates, the parameter is the
administrator information. For ordering Code Signing certificates and S/MIME
certificates, the parameter can be used as the information requested for
certificates. If CSR is N, the information enable to generate CSR. e.g. { "job":
"CEO", "city": "Shangha", "email":
"[email protected]", "state": "Shanghai", "mobile":
"18111111111", "address": " Shanghai", "country": "CN", "lastName": "zhang", "postCode":
"401320", "firstName":
"nick", "organization": "NicSRS" } |
--job |
String |
R |
Administrator’s
title. |
--city |
String |
R |
Administrator city name. |
--email |
String |
R |
Administrator email address. |
--state |
String |
R |
Administrator State name. |
--mobile |
String |
R |
Administrator contact phone number. |
--address |
String |
R |
Administrator contact address. |
--country |
String |
R |
Administrator contact country name. See Appendix - Country codes. |
--lastName |
String |
R |
Administrator’s last
name. |
--postCode |
String |
R |
Administrator contact Postal Code. |
--firstName |
String |
R |
Administrator’s
first name. |
--organization |
String |
R |
Organization name of
administrator. |
-finance |
Json |
O |
Only relevant for SSL
certificates. Details about the Finance Manager. The information can be
consistent with administrator’s. Note: Only required for OV/ EV
certificates. e.g. { "job":
"CEO", "city": "Shanghai", "email":
"[email protected]", "state": " Shanghai", "mobile":
"18111111111", "address": " Shanghai", "country": "CN", "lastName":
"zhang", "postCode":
"401320", "firstName":
"nick", "organization": "NicSRS" } |
--job |
String |
O |
Only relevant for SSL
certificates. Finance Manager’s title. Note: Only required for OV/ EV
certificates. |
--city |
String |
O |
Only relevant for SSL certificates. Finance
Manager city name. Note: Only required for OV/ EV certificates. |
--email |
String |
O |
Only relevant for SSL
certificates. Finance Manager email address. Note: Only required for OV/ EV
certificates. |
--state |
String |
O |
Only relevant for SSL
certificates. Finance Manager State name. Note: Only required for OV/ EV
certificates. |
--mobile |
String |
O |
Only relevant for SSL
certificates. Finance Manager contact phone number. Note: Only required for OV/ EV
certificates. |
--address |
String |
O |
Only relevant for SSL
certificates. Finance Manager contact address. Note: Only required for OV/ EV
certificates. |
--country |
String |
O |
Only relevant for SSL
certificates. Finance Manager contact country name. SeeAppendix - Country codes. Note: Only required for OV/ EV
certificates. |
--lastName |
String |
O |
Only relevant for SSL
certificates. Finance Manager’s last name. Note: Only required for OV/ EV
certificates. |
--postCode |
String |
O |
Only relevant for SSL
certificates. Finance Manager contact Postal Code. Note: Only required for OV/ EV
certificates. |
--firstName |
String |
O |
Only relevant for SSL
certificates. Finance Manager’s first name. Note: Only required for OV/ EV
certificates. |
--organization |
String |
O |
Only relevant for SSL
certificates. Organization name of
Finance Manager. Note: Only required for OV/ EV
certificates. |
-tech |
Json |
O |
Only relevant for SSL
certificates. Details about the technical contact on the order. Note: Only required for OV/ EV
certificates. e.g. { "job":
"Technician", "city": "Shanghai", "email":
"[email protected]", "state": " Shanghai ", "mobile":
"18111111111", "address": " Shanghai", "country": "CN", "lastName":
"zhang", "postCode":
"401320", "firstName":
"nick", "organation": "NicSRS" } |
--job |
String |
O |
Only relevant for SSL
certificates. Technical contact person’s title. Note: Only required for OV/ EV
certificates. |
--city |
String |
O |
Only relevant for SSL
certificates. Technician city name. Note: Only required for OV/ EV
certificates. |
--email |
String |
O |
Only relevant for SSL
certificates. Technician email address. Note: Only required for OV/ EV
certificates. |
--state |
String |
O |
Only relevant for SSL
certificates. Technician State name. Note: Only required for OV/ EV
certificates. |
--mobile |
String |
O |
Only relevant for SSL
certificates. Technician phone number. Note: Only required for OV/ EV
certificates. |
--address |
String |
O |
Only relevant for SSL
certificates. Technician contact address. Note: Only required for OV/ EV
certificates. |
--country |
String |
O |
Only relevant for SSL
certificates. Technician contact country name. See Appendix - Country codes. Note: Only required for OV/ EV
certificates. |
--lastName |
String |
O |
Only relevant for SSL
certificates. Technician’s last name. Note: Only required for OV/ EV certificates. |
--postCode |
String |
O |
Only relevant for SSL
certificates. Technician contact Postal Code. Note: Only required for OV/ EV
certificates. |
--firstName |
String |
O |
Only relevant for SSL
certificates. Technician’s first name. Note: Only required for OV/ EV
certificates. |
--organization |
String |
O |
Only relevant for SSL
certificates. Organization name of
Technician. Note: Only required for OV/ EV
certificates. |
Name |
Type |
Req/Opt |
Description |
code |
Int |
R |
Response status codes. A response code identifies a specific status. See Appendix - Response Codes. |
errors |
Array
or String |
O |
|
data |
Json |
O |
Response data. For more information, see the resource section below. |
-certId |
String |
O |
Certificate ID. Note: please save the value that will be used in other endpoints. |