Renew

Note

The Digital Certificate calls are deprecated. You need to use calls available at SSL Certificates for new orders

Description

Renews an existing Digital Certificate Order.

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 of the Digital Certificate you want to renew.
years Integer Required The number of years for which the certificate is to be renewed.
additional-licenses Integer Required The number of Additional Licenses you want to add for this order.
exp-date Integer Required Current Expiry Date of the Order in epoch time format.
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.
attr-name Map[name] Required Mapping key of the renew 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:

  • software: Web Server software identifier for which the certificate is purchased. Valid Web Server software identifiers are:

    • IIS

    • Other

  • 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 renew details. This together with attr-name shall contain of the renew details. For 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/renew.xml?auth-userid=0&api-key=key&order-id=0&years=1&exp-date=1279012036&invoice-option=NoInvoice&attr-name1=org_name&attr-value1=The organisation Name&attr-name2=org_street1&attr-value2=Organization address

Response

Returns a map of the result of the Renew operation.