reseller

is added when reseller has a customer specific business

Hosting admin Thu, 02/25/2010 - 22:17

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.

Check Availability

Description

Checks the availability of a product for the specified 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 Domain name for which the service availability is to be checked
product-key String Required Product key associated with the product

HTTP Method

GET

Example Test URL


https://test.httpapi.com/api/products/availability.json?auth-userid=0&api-key=key&domain-name=domain.com&product-key=key

Response

Returns true (Boolean) if the product is available for the specified domain name.

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

Activating the DNS Service

Description

Activates the DNS service

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 Order for which the DNS service is to be activated

HTTP Method

POST

Example Test URL Request

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

Response

Returns a map containing status information.

Activating the Domain Forwarding Service

Description

Activates the Domain Forwarding service.

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 which Domain Forwarding service needs to be activated

HTTP Method

POST

Example Test URL Request

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

Response

Returns a map containing status information.

Subscribe to reseller