reseller

is added when reseller has a customer specific business

Reissue

Description

Reissues an existing Digital Certificate.

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 reissue the certificate.
csr-string String Required Base64 encoded CSR string complete with the begin and end markers.
csr-software String Required Web Server software identifier for which the certificate is to be reissued.Valid identifiers are:IIS,Other
approver-email String Required The approver email of the certificate must match the registrant/admin contact of the domain.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/digitalcertificate/reissue.xml?auth-userid=0&api-key=key&order-id=0&csr-string=-----BEGIN NEW CERTIFICATE REQUEST---MIIBwzCCASwCAQAwgYIxCzAJBgNVB-----END NEW CERTIFICATE REQUEST----&csr-software=IIS&[email protected]

Response

Returns a map of the result of the Reissue action.

Enroll

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. [email protected]).

    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 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.

Getting the Order Id

Description

Returns the Digital Certificate Order Id associated with the domain name.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key or auth-password String Required Authentication Parameter
domain-name String Required The domain name for which the Digital Certificate Order Id to be fetched.

HTTP Method

GET

Example Test URL Request


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

Response

Returns the Order Id associated with the specified domain name.

Check Status

Description

Check the status of the specified 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 Order Id of the Order which has to be canceled.
standard-certificate-format boolean Required Type of the certificate format. Values can be:
  • true: for standard (X509) certificate format

  • false: for pkcs7text (PKCS#7) certificate format

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/digitalcertificate/check-status.xml?auth-userid=0&api-key=key&order-id=0&standard-certificate-format=true

Response

Returns a map having certificate status details.

Cancel

Description

Cancels the specified 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 Order Id for the Order which has to be canceled.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/digitalcertificate/cancel.xml?auth-userid=0&api-key=key&order-id=0

Response

Returns a map with the status of action.

Delete

Description

Deletes the specified 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 Order Id of the Digital Certificate Order which has to be deleted.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/digitalcertificate/delete.xml?auth-userid=0&api-key=key&order-id=0

Response

Returns a map with the status of deletion action.

Details

Description

Gets details of the specified Digital Certificate Order based on various options.

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 Order Id for which details are required
option Array of Strings Required Vector of different option for details listing. Allowed Option values are:
  • All

  • StatusDetails

  • orderInfo

  • orderDetailedInfo

  • OrderDetails

  • ExecutionInfoParams

  • customerDetails

  • resellerdetails

  • ConflictDetails

  • PricingDetails

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/digitalcertificate/details.xml?auth-userid=0&api-key=key&order-id=0&option=All

Response

Returns a map for all fields depending upon option selected.

Getting Customer Details By Username

Description

Gets the Customer details for the specified Customer Username.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
username String Required Username of the Customer

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/customers/details.json?auth-userid=0&api-key=key&[email protected]

Response

Returns a hash map containing the below details:

  • Customer Id (customerid)

  • Customer Username (username)

  • Reseller Id of the Parent Reseller (resellerid)

  • Name (name)

  • Company (company)

  • Email Address (useremail)

  • Telephone Number Country Code (telnocc)

  • Telephone Number (telno)

  • First line of address of the Customer (address1)

  • Second line of address of the Customer (address2)

  • Third line of address of the Customer (address3)

  • City (city)

  • State (state)

  • Country Code (country)

  • ZIP Code (zip)

  • Personal Identification Number (pin)

  • Creation Date (creationdt)

  • Current Status (customerstatus)

  • Sales Contact Id (salescontactid)

  • Language Preference for the Control Panel and Emails (langpref)

  • Total Receipts (totalreceipts)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Executing an Order Without Payment

Description

Executes the pending actions against the specified Invoice Ids. You can also specify whether the Invoices need to be cancelled or kept pending.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
invoice-ids Array Of Integer Required Invoice Ids whose associated pending actions are to be executed
cancel-invoice Boolean Required

Indicates whether the Invoice needs to be cancelled or kept pending. Values can either be:

  • true - will cancel the Invoice and execute the action (to be used in cases where payment has been received through offline methods), or

  • false - will keep the Invoice pending and execute the action (for settlement upon receipt of payment at a later stage).

HTTP Method

POST

Example Test URL Request

https://test.httpapi.com/api/billing/execute-order-without-payment.xml?auth-userid=0&api-key=key&invoice-ids=0&invoice-ids=1&cancel-invoice=true

Response

Returns a hash map of executed actions containing the below details:

  • Invoice Id (invoiceid)

  • Order Id associated with the Invoice (51821176)

  • Customer Id associated with the Invoice (customerid)

  • Action Id of the Action associated with the Invoice (eaqid)

  • Action Type of the Action associated with the Invoice (actiontype)

  • Description of the Action associated with the Invoice (actiontypedesc)

  • Domain Name (description)

  • Status of the Action associated with the Invoice (actionstatus)

  • Description of the Action Status (actionstatusdesc)

  • Selling Currency Symbol of the Parent Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Getting a Customer's Available Balance

Description

Gets the Available Balance of the specified Customer.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customer-id Integer Required Customer Id of the Customer whose Available Balance is to be fetched

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/billing/customer-balance.json?auth-userid=0&api-key=key&customer-id=0

Response

Returns a hash map of the Customer's Available Balance containing the below details:

  • Selling Currency Symbol of the Parent Reseller (currencysymbol)

  • Available Balance Amount in the Selling Currency (sellingcurrencybalance)

  • Locked Amount in the Selling Currency (sellingcurrencylockedbalance)

  • Total Balance Amount in the Selling Currency (totalsellingbalance)

  • Available Balance Amount in the Accounting Currency (accountingcurrencybalance)

  • Locked Amount in the Accounting Currency (accountingcurrencylockedbalance)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.