Description
Enrolls for the Certificate for the specified Order Id.
Parameters
| Name |
Data Type |
Required / Optional |
Description |
| auth-userid |
Integer |
Required |
Authentication Parameter |
| api-key or auth-password |
String |
Required |
Authentication Parameter |
| order-id |
Integer |
Required |
The Order Id for which you want to enroll for a Certificate. |
| attr-name |
Map[name] |
Required |
Mapping key of the enrollment details. Refer the description of attr-value.
Following is the list of the expected Atrribute Names:
-
org_name: Organisation Name
-
org_street1: Organization address
-
org_city: Organization city
-
org_state: Organization state
-
org_postalcode: Organization Postal code
-
org_country: Organization two letter ISO-3166 country identifier i.e. country code. (eg. US for United States, IN for India)
-
org_phone: Organization contact Phone number including international country code. (eg. 001 415 12345678)
-
org_fax: Organization contact Fax number including international country code. (eg. 001 415 12345678)
-
admin_firstname: First name of the Admin contact person
-
admin_lastname: Last name of the Admin contact person
-
admin_jobtitle: Admin contact job title
-
admin_telephone: Admin contact telephone number including international country code. (eg 001 415 12345678)
-
admin_email: Admin Contact email address
-
tech_firstname: First name of the technical contact person
-
tech_lastname: Last name of the technical contact person
-
tech_jobtitle: Technical contact job title
-
tech_telephone: Technical contact telephone number including international country code. (eg 001 415 12345678)
-
tech_email: Technical Contact email address
-
approveremail: The approverEmail value (e.g. ssladmin@domainname.com).
Valid approverEmail values are:
-
One of the registered domain contacts (admin or tech) found in the whois database for the associated domain.
-
Or one of the pre-setup emails listed below. For sub domains an email @domainname.com is also valid
-
software: Web Server software identifier for which the certificate is purchased. Valid Web Server software identifiers are:
-
csrString: Base64 encoded CSR string complete with the begin and end markers.
Example:
-----BEGIN NEW CERTIFICATE REQUEST----- MIIBwzCCASwCAQAwgYIxCzAJBgNVBAYTAklOMRQwEgYDVQQIEwtNYWhhcmFzaHRyYTEPMA0GA1UE BxMGTXVtYmFpMRcwFQYDVQQKEw5NYWhlc2ggUHZ0IEx0ZDEYMBYGA1UECxMPUHJpdmF0ZSBDb21w YW55MRkwFwYDVQQDExB2ZXJpZW5yb2xsMDEuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKB gQCMSw8CmFebNAiyvwG7HJ/bGBqgqZvkNpzQtmtd79id+LcAXbCx5+TDdoTeGhQ33dUC2c2g5dxx N2hqRlR1H+vFR/FeYXC41abfPm5jS3OTQ4J1H/HM6lm4MVVEIQLwjzUxPtsUML5QtBjkolob2VB7 8A9QdDvSEkS+COaMXRSUqQIDAQABoAAwDQYJKoZIhvcNAQEEBQADgYEACCpjqsN2ZRjGtPTWp1G+ jHTrgAamxSDrHAddw9mi1IDk1N3ZXgp5gHBZ4L5av+4E6GUhTE5FCLylNxojxMjHnssALFjabqed ufJIj0ay8YSS6fBhXQeVE4oGP96djeheLLigCEAufzWjprr6oA6YRXmwAAdokmpkjyxwrtlNV0I= -----END NEW CERTIFICATE REQUEST-----
|
| attr-value |
Map[value] |
Required |
Mapping value of of the enrollment details. This together with attr-name shall contain of the enrollment details.
Example:
attr-name1=org_name&attr-value1=The organisation Name&attr-name2=org_street1&attr-value2=Organization address |
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/digitalcertificate/enroll-for-thawtecertificate.xml?auth-userid=0&api-key=key&order-id=0&attr-name1=org_name&attr-value1=name&attr-name2=org_street1&attr-value2=Organizationaddress
Response
Returns a map of the result of the enrollment action.