reseller

is added when reseller has a customer specific business

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.

Activate

Description

Activates the Free Email 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 Free Email service needs to be activated

HTTP Method

POST

Example Test URL

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

Response

Returns a map containing status information.

Getting Promo Prices

Description

Gets the Reseller's Promo prices.

Note

It is recommended you cache all pricing information to ensure you do not have to send API queries to the platform. As there are a huge number of products, the accompanying data may cause longer wait time than usual.

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 Request


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

Response

Returns a hash map containing the below details:

    • Reseller Id (resellerid)

    • Product Key (productkey)

    • Promo Start Time (starttime)

    • Promo End Time (endtime)

    • Promo Period (period)

    • Discounted Price (resellerpriceone)

    • Standard Price (resellerpricetwo)

    • Customer Price (customerprice)

    • Barrrier Price (barrierprice)

    • Price Applicable to the Sub-Reseller (resellerprice)

    • Currency Symbol of the Price Applicable to the Sub-Reseller (resellerpricecurrencysymbol)

    • Type of Action the Promo is Applicable for (actiontype)

    • Selling Currency of the Registration Service Provider (serviceprovidersellingcurrency)

    • Promo Status (isactive)

    • Whether the Promo can be trickled down the Sub-Reseller chain (istrickleallow)

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