reseller

Description

Unsuspends a suspended customer account. 

HTTP Method

POST

Example Test URL Request

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

Description

Suspends a customer account. 

HTTP Method

POST

Example Test URL Request

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

URL

The HTTP API is available at:

https://httpapi.com/

Authentication

All requests require the following authentication parameters:

• auth-userid: Your Live Account Reseller Id (See the instructions below for finding your Reseller Id).

Description

Returns an authentication token for a Customer.

You can login to the Customer's Control Panel using the generated token. The Control panel can be accessed at following link, where XXXXX is the generated token.

http://hosting-spruko.manage-orders.com/servlet/AutoLoginServlet?userLoginId=XXXXX&role=customer

HTTP Method

GET

Description

Validates upgrade/downgrade for a particular CodeGuard Order.

Parameters

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/codeguard/validate-modify.json?auth-userid=0&api-key=key&order-id=0&new-planid=0


Response

Returns true (String) if upgrade/downgrade is validated successfully.

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

Description

Gets the applicable upgrade/downgrade price for a particular CodeGuard Order.

Parameters

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/codeguard/modify-pricing.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0


Response

Returns the applicable upgrade/downgrade price for a particular CodeGuard Order.

Example:


{
"upgradecost":0.0,
"modifiedOrderPrice":0.0,
"endtime":"0000000000",
"remainingmonths":0,
"currentOrderPrice":0.0
}


where

• currentOrderPrice: The current pricing of the Order for remaining months.

• modifiedOrderPrice: New applicable pricing of the Order as per the new plan.

• upgradecost: Actual price applicable i.e. modifiedOrderPrice - currentOrderPrice

Description

Validates upgrade for a particular SiteLock Order.

Parameters

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/sitelock/validate-modify.json?auth-userid=0&api-key=key&order-id=0&new-planid=0


Response

Returns true (String) if upgrade is validated successfully.

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

Description

Gets the applicable upgrade price for a particular SiteLock Order.

Parameters

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/sitelock/modify-pricing.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0


Response

Returns the applicable upgrade price for a particular SiteLock Order.

Example:


{
"upgradecost":0.0,
"modifiedOrderPrice":0.0,
"endtime":"0000000000",
"remainingmonths":0,
"currentOrderPrice":0.0
}


where

• currentOrderPrice: The current pricing of the Order for remaining months.

• modifiedOrderPrice: New applicable pricing of the Order as per the new plan.

• upgradecost: Actual price applicable i.e. modifiedOrderPrice - currentOrderPrice

Description

Upgrades an existing SiteLock order.

Parameters

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/sitelock/modify.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&invoice-option=NoInvoice


Response

Returns a hash map containing the below details:

• Domain Name (description)

• Order ID of the SiteLock Order (entityid)

• Action Type (actiontype)

• Description of the SiteLock Order Upgrade Action (actiontypedesc)

• Action ID of the SiteLock Order Upgrade Action (eaqid)

• SiteLock Order Upgrade Action Status (actionstatus)

• Description of the SiteLock Order Upgrade Action Status (actionstatusdesc)

• Invoice ID of the SiteLock Order Upgrade Invoice (invoiceid)

• Selling Currency of the Reseller (sellingcurrencysymbol)

• Transaction Amount in the Selling Currency (sellingamount)

• Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

• Customer ID associated with the SiteLock Order (customerid)

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

Description

Authenticates the token provided by the system while redirecting a Customer to your custom URL and returns the Customer details, if authenticated.

Parameters

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/customers/authenticate-token-without-history.json?auth-userid=0&api-key=key&token=authenticationtoken


Response

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

• Customer Id (customerid)

• Customer Username (username)

• Your Reseller Id (resellerid)

• Reseller Id of your Parent Reseller (parentid)

• Name (name)

• Company (company)

• Email Address (useremail)

• Telephone Number Country Code (telnocc)

• Telephone Number (telno)

• First line of address of the Customer (address1)

• Second line of address of the Customer (address2)

• Third line of address of the Customer (address3)

• City (city)

• State (state)

• Country Code (country)

• ZIP Code (zip)

• Personal Identification Number (pin)

• Creation Date (creationdt)

• Current Status (customerstatus)

• Sales Contact Name and Email Id (salesrepresentative)

• Language Preference for the Control Panel and Emails (langpref)

• Total Receipts (totalreceipts)

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