reseller

is added when reseller has a customer specific business

Adding an Email Hosting Order (Deprecated)

Description

Note

This method has been deprecated. You can use these methods instead.

Places an Email Hosting Order for the specified 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 Order is placed.
customer-id Integer Required The Customer under whom the Orders should be added.
months Integer Required The number of months for which the Order is placed.
invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Value can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail-hosting/add.xml?auth-userid=0&auth-password=password&domain-name=name&customer-id=0&months=1&invoice-option=NoInvoice

Response

Returns a map with the result of Order addition.

Adding a Windows Hosting Order (Deprecated)

Description

Note

This method has been deprecated. You can use these methods instead.

Places a Windows Hosting Order for the specified 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 Order is placed.
customer-id Integer Required The Customer under whom the Orders should be added.
months Integer Required The number of months for which the Order is placed.
enable-ssl Boolean Required SSL enabled
invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Value can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/windows-hosting/add.xml?auth-userid=0&auth-password=password&domain-name=name&customer-id=0&months=1&enable-ssl=true&invoice-option=NoInvoice

Response

Returns a map with the result of Order addition.

Description

Places a Windows Hosting Order for the specified 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 Order is placed.
customer-id Integer Required The Customer under whom the Orders should be added.
months Integer Required The number of months for which the Order is placed.
enable-ssl Boolean Required SSL enabled
invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Value can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/windows-hosting/add.xml?auth-userid=0&auth-password=password&domain-name=name&customer-id=0&months=1&enable-ssl=true&invoice-option=NoInvoice

Response

Returns a map with the result of Order addition.

Adding a Linux Hosting Order (Deprecated)

Description

Note

This method has been deprecated. You can use these methods instead.

Places a Linux Hosting Order for the specified 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 Order is placed.
customer-id Integer Required The Customer under whom the Orders should be added.
months Integer Required The number of months for which the Order is placed.
enable-ssl Boolean Required SSL enabled
invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/linux-hosting/add.xml?auth-userid=0&auth-password=password&domain-name=name&customer-id=0&months=1&enable-ssl=true&invoice-option=NoInvoice

Response

Returns a map with the result of Order addition.

Get Legal Agreements

Description

Gets the default and customized Legal Agreements.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
type Array of Strings Required Values can be: resellermasteragreement, customermasteragreement, resellerdomainagreement, customerdomainagreement, resellerwebserviceagreement, customerwebserviceagreement, resellerdigicertagreement, customerdigicertagreement, registraragreement, customerhostingproductagreement or resellerhostingproductagreement.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/commons/legal-agreements.xml?auth-userid=0&api-key=key&type=type

Response

Returns a hash map of the Legal Agreements containing the below details:

  • Default Agreement Text (defaultagreement)

  • Whether the Default Agreement has been selected for use (agreementflag)

  • Customized Agreement Text (agreement)

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

Get Details

Description

Gets the details of the active products.

Parameters

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

HTTP Method

GET

Example Test URL


https://test.httpapi.com/api/products/details.json?auth-userid=0&api-key=key

Response

Returns a map with key as productkey and value as another map containing the details of the product corresponding to the product key. If you are offering FREE Email Service, this method will also return details related to it.