sslcert

If the Reseller is selling Comodo SSL certificates

Get Order Id

Description

Returns the SSL Certificate order id associated with the Domain Name.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name String Required -

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/sslcert/orderid.xml?auth-userid=0&api-key=key&domain-name=xyz

Response

Returns the order id associated with the specified Domain Name.

Search

Description

Gets a list of SSL Certificate orders matching the search criteria, along with the details.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
no-of-records Integer Required Number of orders to be fetched. This should be a value between 10 to 500.
page-no Integer Required Page number for which details are to be fetched.
order-id Array of Integers Optional Order ID(s) of the SSL Certificate Order(s) whose details need to be fetched
reseller-id Array of Integers Optional Reseller Id(s) of the Reseller(s) whose Orders need to be fetched
customer-id Array of Integers Optional Customer Id(s) of the Customer(s) whose Orders need to be fetched
show-child-orders Boolean Optional Fetch Sub-Reseller's orders as well
status Array of Strings Optional Active, Deleted etc.
domain-name String Optional Domain name associated with the SSL Certificate Order
creation-date-start String Optional UNIX TimeStamp for listing of SSL Certificate orders whose creation date is greater than creation-date-start.
creation-date-end String Optional UNIX TimeStamp for listing of SSL Certificate orders whose creation date is less than creation-date-end.
expiry-date-start String Optional UNIX TimeStamp for listing of SSL Certificate orders whose expiry date is greater than expiry-date-start.
expiry-date-end String Optional UNIX TimeStamp for listing of SSL certificate orders whose expiry date is less than expiry-date-end.
order-by Array of Strings Optional One or more parameters by which you want to sort the Orders. Default is orderid.

Example:

If page-no is 1, no-of-records is 30 and order-by is orderid; it will fetch the first 30 Orders which suit the search criteria sorted by orderid. If page-no is 2, no-of-records is 30 and order-by is orderid; it will fetch the second batch of 30 Orders sorted by orderid.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/sslcert/search.json?auth-userid=0&api-key=key&order-id=0&reseller-id=1&customer-id=1&show-child-orders=true&status=active&domain-name=yourdomain.com&creation-date-start=1415463675&creation-date-end=12345678&expiry-date-start=109678457&expiry-date-end=98765432&no-of-records=1&page-no=2&order-by=reseller-id

Response

Returns the details of the SSL Certificate orders which match the search criteria.

Renew

Description

Renews an existing SSL Certificate order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required -
months Integer Required The number of months for which the certificate is to be renewed.
invoice-option String Required This will decide how the Customer Invoice will be handled. Set any of below mentioned Invoice Options for your Customer:
  • NoInvoice: This will not raise any Invoice. The Order will be renewed

  • PayInvoice: This will raise an Invoice and:

    • if there is sufficient balance in the Customer's Debit Account, then the Invoice will be paid and the Order will be renewed.

    • if there is insufficient balance in the Customer's Debit Account, then the Order will remain pending in the system.

  • KeepInvoice: This will raise an Invoice for the Customer to pay later. The Order will be Renewed.

  • OnlyAdd: This will raise an Invoice for the Customer to pay later. The Order renewal request will remain pending.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/sslcert/renew.xml?auth-userid=0&api-key=key&order-id=0&months=1&invoice-option=NoInvoice

Response

Returns a hash map of the result of the Renew operation.

Reissue

Description

Reissues an existing SSL Certificate.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required -
csr String Required Base64 encoded CSR string complete with the begin and end markers.
verification-email String Required For a list of approved email id see
address String Optional Address of the organization
Note

This parameter is compulsory in case of Comodo EV Certificate.

zip String Optional Zip/Postal Code
Note

This parameter is compulsory in case of Comodo EV Certificate.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/sslcert/reissue.xml?auth-userid=0&api-key=key&order-id=0&csr=-----BEGIN NEW CERTIFICATE REQUEST---MIIBwzCCASwCAQAwgYIxCzAJBgNVB-----END NEW CERTIFICATE REQUEST----&verification-email=wew@approver.com

Response

Returns a hash map of the result of the reissue action.

Enroll

Description

Enroll the certificate for the specified order id.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The order id for for the certificate.
csr String Required CSR
verification-email String Required For a list of approved email address please see this link.
dba String Optional Doing Business As
Note

The value for this parameter cannot be changed later.

address String Optional Address of the organization
Note

This parameter is compulsory in case of Comodo EV Certificate.

zip String Optional Zip/Postal Code
Note

This parameter is compulsory in case of Comodo EV Certificate.

country-of-incorporation String Optional 2 letter country-code of the country in which the organization was incorporated
Note
  • This parameter is compulsory in case of Comodo EV Certificate.

  • The value for this parameter cannot be changed later.

app-rep-email String Optional Email address of the individual authorized to accept Comodo Agreements
Note
  • This parameter is compulsory in case of Comodo EV Certificate.

  • The value for this parameter cannot be changed later.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/sslcert/enroll.json?auth-userid=0&api-key=key&order-id=0&csr=-----BEGIN NEW CERTIFICATE REQUEST---MIIBwzCCASwCAQAwgYIxCzAJBgNVB-----END NEW CERTIFICATE REQUEST---&verification-email=test@yourdomain.com

Response

Returns a hash map of the enrollment action.

Add

Description

Places an SSL Certificate order for the specified Domain Name.

Parameters

Name Data Type Required / Optional Description
domain-name String Required The domain name for which the Order is to be placed
months Integer Required The number of months for which the Order is to be placed
customer-id Integer Required The Customer under whom the Order should be added
plan-id Integer Required The plan under which the Order should be added. To fetch the plan details i.e. plan-id etc., use this method.
invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/sslcert/add.json?auth-userid=0&api-key=key&domain-name=name&months=0&customer-id=0&plan-id=0&invoice-option=NoInvoice

Response

Returns a hash map containing the order addition information.

How do I generate a Certificate Signing Request (CSR)?

Generating a CSR is the first step you must perform in order to apply for an SSL Certificate.

This can be done from your web server control panel, and requires you to enter the following details about your website and organization:

  • Organization Name
  • Organizational unit: This describes the type of your organization. For e.g. Sole Proprietorship, Government Department, Public (Listed) Company, Private (Unlisted) Company, etc.
  • Country Code
  • State or Province
  • Locality
  • Common Name: This is the domain name for which you have purchased the SSL Certificate.
Note
  • The Common Name should match the domain name of the order. If you have purchased the SSL Certificate for yourdomain.com, you need to enter yourdomain.com as the Common Name.
  • For wildcard certificates, enter the Common Name as *.yourdomain.com. This means that the certificate will be issued for all sub-domains of yourdomain.com.
  • The SSL Certificate issued will be valid for yourdomain.com as well as www.yourdomain.com.

Once you enter these details, you will receive an encoded file – your CSR. This CSR can now be used to submit your SSL Certificate application to the Certificate Authority.

How to generate a CSR on a specific web server

If your website is hosted with then click here to generate a CSR.
If your website is hosted with another provider then depending upon your web server/control panel click on the link below:

  

 

Important

  • When generating your CSR, ensure that you set the key size to 2048-bit or higher.
  • If you get an error that says that the CSR is invalid, double-check the information entered while generating your CSR and generate a new CSR.
  • Ensure that you keep your private key confidential.

 

 

  

 

How do I install an SSL Certificate?

After your SSL Certificate is issued it will be available in your control panel. You can locate and install it by following the steps below.

Locate your SSL Certificate

Step 1: Log in to your control panel. Learn how

Step 2: Navigate to the Order Information view.

 Type the Domain Name of the order in the search field on the homepage, select Order from the drop down and click on the Search button.

 

Step 3: Retrieve your SSL Certificate.       

In the Order Information view, click on View certificate details.

 

A pop-up will display your certificate as shown below:

 

          

Install your SSL Certificate

Depending upon the web server where you intend to install your SSL Certificate, you need to refer to the appropriate instructions below:

Cpanel

Plesk

Microsoft IIS 5.x & 6.x

Microsoft IIS 7.x

Apache

NGINX

OS X Lion (10.7) Server

Others

 

Important

In order to install your SSL Certificate you will also need the SSL Certificate of the Certificate Authority (i.e the CA bundle). The CA bundle contains root and intermediate certificates of the CA and is available for download from here