reseller

is added when reseller has a customer specific business

Generating a Login Token

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://demo.myorderbox.com/servlet/AutoLoginServlet?userLoginId=XXXXX&role=customer

Note

The token will be valid for a duration of only 120 seconds.

HTTP Method

GET

Validate Upgrade/Downgrade

Description

Validates upgrade/downgrade for a particular CodeGuard Order.

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 of the CodeGuard Order for which upgrade/downgrade needs to be validated
new-planid Integer Required The new plan to which the Order is to be upgraded/downgraded. To fetch the plan details: plan-id etc., use this method.

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.

Get Upgrade/Downgrade Price

Description

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

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 of the CodeGuard Order for which the details are to be fetched
new-plan-id Integer Required The new plan to which the Order is to be upgraded/downgraded. To fetch the plan details: plan-id etc., use this method.
months Integer Required The number of months (tenure) in the new plan for which the Order to be placed

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

Validate Upgrade

Description

Validates upgrade for a particular SiteLock Order.

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 of the SiteLock Order for which upgrade needs to be validated
new-planid Integer Required The new plan to which the Order is to be upgraded. To fetch the plan details: plan-id etc., use this method.

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.

Get Upgrade Price

Description

Gets the applicable upgrade price for a particular SiteLock Order.

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 of the SiteLock Order for which the details are to be fetched
new-plan-id Integer Required The new plan to which the Order is to be upgraded. To fetch the plan details: plan-id etc., use this method.

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

Upgrade

Description

Upgrades an existing SiteLock order.

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 of the Order which is to be upgraded
new-plan-id Integer Required The new plan to which the Order is to be upgraded. To fetch the plan details i.e. plan-id etc, use this method.
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/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)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

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

Authenticating a Token passed to a Custom URL

Description

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

Note

If you have chosen to redirect all purchase related links from within your and your Customers' Control Panel to a custom URL, you must check that the redirection is being made by an authenticated Customer or user. The authenticity can be checked using this API call.

Additional Information

Integrating your Website and Shopping Cart with your and your Customers' Control Panel

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

Subscribe to reseller