reseller

is added when reseller has a customer specific business

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

Authenticate Token

Description

Authenticates token generated by the Generate Token method & returns the Sub-Reseller details, if authenticated.

Parameters

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

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/resellers/authenticate-token.json?auth-userid=0&api-key=key&token=generatedtoken

Response

Returns a hash map containing the below details if the token is authenticated:

    • Company (company)

    • Name (name)

    • Brand Name (brandname)

    • Reseller Id (resellerid)

    • Parent Id (parentid)

    • Sub-Reseller Status (resellerstatus)

    • Creation Date (creationdt)

    • Total Receipts (totalreceipts)

    • Address (address1)

    • City (city)

    • State (state)

    • Other State (other_state)

    • ZIP (zip)

    • Country (country)

    • Telephone Number Country Code (telnocc)

    • Telephone Number (telno)

    • Username (username)

    • Password (password)

    • Personal Identification Number (pin)

    • Language Preference (langpref)

    • Selling Currency Symbol (sellingcurrencysymbol)

    • Accounting Currency Symbol (accountingcurrencysymbol)

    • Sales Contact Id (salescontactid)

    • Billing Contact From Name (billingfromname)

    • Billing Contact Telephone Number Country Code (billingtelnocc)

    • Billing Contact Telephone Number (billingtelno)

    • Billing Contact Email Address (billingemailaddr)

    • Sales Contact From Name (salesfromname)

    • Sales Contact Telephone Number Country Code (salestelnocc)

    • Sales Contact Telephone Number (salestelno)

    • Sales Contact Email Address (salesemailaddr)

    • Sales Contact Signature (salessignature)

    • Technical Support Contact Telephone Number Country Code (technicalsupporttelnocc)

    • Technical Support Contact Telephone Number (technicalsupporttelno)

    • Technical Support Contact Email Address (technicalsupportmailaddr)

    • Abuse Desk Contact From Name (abusefromname)

    • Abuse Desk Contact Email Address (abuseemailaddr)

    • Abuse Desk Contact Signature (abusesignature)

    • Selling Currency Symbol of the Parent Reseller (parentsellingcurrencysymbol)

    • Funds Threshold Level (fundthreshold)

    • Minimum Total Receipts Required for Sub-Reseller Activation (minreceiptrequire)

    • Minimum Transaction Amount for making Payments Online (minimumbillingamount)

    • Minimum Transaction Amount for Adding Funds Online (minimumaddfundamount)

    • Offline Payment Details for Customers (directpaymentdetails_customer)

    • Offline Payment Details for Resellers (directpaymentdetails_reseller)

    • Whether Offline Payment Details Displayed to Customers (showdirectPayment_customer)

    • Whether Offline Payment Details Displayed to Resellers (showdirectpayment_reseller)

    • Conversion Rate (conversionrate)

    • Whether using System Conversion Rate (usesystemconversionrate)

    • Whether Generation of Risk Assessment Reports Enabled (sendriskreportmail)

    • Whether Sub-Reseller Signup is Restricted (isresellerrestricted)

    • Whether Automatic Signup for New Products Enabled (futureProductSignup)

    • Branding URL of the Parent Reseller (parentbrandingurl)

    • Partially Branded SuperSite 2 URL (partialsupersite2url)

    • Partially Branded PartnerSite URL (partialpartnersiteurl)

    • Partially Branded Control Panel URL (brandingurl)

    • Fully Branded SuperSite 2 URL (supersite2url)

    • Fully Branded SuperSite URL (supersiteurl)

    • Fully Branded PartnerSite URL (partnersiteurl)

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

Generate Token

Description

Authenticates Sub-Reseller and returns authentication token, if the Sub-Reseller is authenticated successfully.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
ip String Required IP Address of the Sub-Reseller

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/resellers/generate-token.json?auth-userid=0&api-key=key&ip=1.1.1.1

Response

Returns the below details if the Sub-Reseller is authenticated successfully:

  • Company (company)

  • Name (name)

  • Sub-Reseller Brand Name (brandname)

  • Reseller Id (userid)

  • Username (username)

  • Parent Id (parentid)

  • Sub-Reseller Account Status (resellerstatus)

  • Token (userLoginId)

  • Technical Support Contact Email Address (technicalsupportmailaddr)

  • Technical Support URL (technicalsupporturl)

  • Accounting Currency Symbol (accountingcurrencysymbol)

  • Selling Currency Symbol (sellingcurrencysymbol)

  • Whether Password has Expired (ispasswdexpired)

  • Signout URL (logoutURL)

  • Language Preference for Contro Panel and Emails (langpref)

  • Country (country)

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