reseller

is added when reseller has a customer specific business

Move

Description

Moves all products from one customer to other customer.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name String Required Domain name that needs to be moved
existing-customer-id Integer Required Existing Customer ID from which the products are to be transferred
new-customer-id Integer Required New Customer ID to which the products are to be transferred
default-contact String Required
Attention

This API Parameter will be deprecated from 1st December 2016 due to IRTP changes in the system. This parameter will not be required post 1st December 2016 as by default only the old contact can be used.

Value to indicate whether the old Contact has to be retained or to use the Default Contact of the new Customer. Valid entries are oldcontact or default.

Note

In case of a .CN domain name, the Default Contact of the new Customer cannot be associated with the domain name and the old Contact has to be retained. Hence, oldcontact
will be the only valid value.

Note

In case of a .ES domain name, the Default Contact of the new Customer cannot be associated with the domain name and the old Contact has to be retained. Hence, oldcontact
will be the only valid value.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/products/move.json?auth-userid=0&api-key=key&domain-name=domain.com&existing-customer-id=0&new-customer-id=0&default-contact=oldcontact

Response

Returns a hash map containing a status key with value as Success, if the move request is accepted by the system for processing.

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

Disabling the Theft Protection Lock

Description

Disables the Theft Protection Lock on the specified order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order Id of the Domain Registration Order on which the Theft Protection Lock is to be removed.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/disable-theft-protection.json?auth-userid=0&api-key=key&order-id=0

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Domain Registration Order (entityid)

  • Action Type (actiontype)

  • Description of the Disable Theft Protection Action (actiontypedesc)

  • Action ID of the Disable Theft Protection Action (eaqid)

  • Disable Theft Protection Action Status (actionstatus)

  • Description of the Disable Theft Protection Action Status (actionstatusdesc)

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

Enabling the Theft Protection Lock

Description

Applies the Theft Protection Lock on the specified Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order Id of the Domain Registration Order on which the Theft Protection Lock to be applied.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/enable-theft-protection.json?auth-userid=0&api-key=key&order-id=0

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Domain Registration Order (entityid)

  • Action Type (actiontype)

  • Description of the Enable Theft Protection Action (actiontypedesc)

  • Action ID of the Enable Theft Protection Action (eaqid)

  • Enable Theft Protection Action Status (actionstatus)

  • Description of the Enable Theft Protection Action Status (actionstatusdesc)

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

Get the List of Locks Applied on a Domain Name

Description

Gets the list of the Locks applied on the specified Domain Registration Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order Id of the Domain Registration Order whose list of the locks need to be fetched.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/domains/locks.json?auth-userid=0&api-key=key&order-id=0

Response

Returns a hash map containing the list of Locks applied on the Domain Registration Order as below:

  • Reseller Lock (resellerlock) with details as -

    • Reseller ID of the Reseller who placed the Reseller Lock (lockerid)

    • Company Name of the Reseller who placed the Reseller Lock (addedby)

    • Reason for placing the Reseller Lock (reason)

    • Timestamp when the Reseller Lock was placed (creationdt)

  • Transfer Lock (transferlock) with value as true, if set

  • Customer Lock (customerlock) with value as true, if Transfer Lock set.

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

Get OrderID (Deprecated)

Note

These methods have been deprecated. You can use these methods instead.

Description

Returns the SiteBuilder OrderId associated with the domain name.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
auth-password String Required Authentication Parameter
domain-name String Required The domain name for which the details are required.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/sitebuilder/order-id.xml?auth-userid=1&auth-password=password&domain-name=xyz

Response

Returns the OrderId associated with the given domain name.

Modify FTP Details (Deprecated)

Note

These methods have been deprecated. You can use these methods instead.

Description

Modifies FTP details.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
auth-password String Required Authentication Parameter
order-id Integer Required The orderid for which you want to enroll for a certificate.
ftphost String Required FTP Host Value.
ftpport String Required FTP Port Value
ftpusername String Required FTP Username
ftppassword String Required FTP Password
ftppath String Required FTP Path

HTTP Method

POST

Example Test URL


https://test.httpapi.com/api/sitebuilder/modify-ftp-details.xml?auth-userid=1&auth-password=password&order-id=12&ftphost=host&ftpport=80&ftpusername=test&ftppassword=password&ftppath=test

Response

Returns a map of the result.

Delete (Deprecated)

Note

These methods have been deprecated. You can use these methods instead.

Description

Deletes the specified Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
auth-password String Required Authentication Parameter
order-id Integer Required OrderId for the order which has to be deleted.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/sitebuilder/delete.xml?auth-userid=1&auth-password=password&order-id=12

Response

Returns a map with the status of action.

Get Order Details (Deprecated)

Note

These methods have been deprecated. You can use these methods instead.

Description

Gets details for a particular SiteBuilder Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
auth-password String Required Authentication Parameter
order-id Integer Required OrderId for which details are required.
option Array of Strings Required Vector of different option for details listing. Allowed Option values are:
  • All

  • ConflictDetails

  • PricingDetails

  • OrderDetails

  • StatusDetails

  • ExecutionInfoParams

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/sitebuilder/details.xml?auth-userid=1&auth-password=password&order-id=1233&option=All

Response

Returns a map containing all the details depending upon the options specified.

Deleting a Customer

Description

Deletes the specified Customer, if the Customer does not have any Active Order(s).

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 that you want to delete

HTTP Method

POST

Example Test URL Request


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

Response

Returns true (Boolean), if the specified Customer is deleted.

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

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