Suspend Customer Account
Description
Suspends a customer account.
 |
reseller
is added when reseller has a customer specific business
Generating a Login Token
Description
Returns an authentication token for a Sub-Reseller.
You can login to the Sub-Reseller's Control Panel using the generated token. The Control panel can be accessed at following link, where XXXXX is the generated token.
/servlet/AutoLoginServlet?userLoginId=XXXXX&role=reseller
Note
The token will be valid for a duration of only 120 seconds.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| reseller-id | Integer | Required | Reseller ID of the Sub-Reseller |
| ip | String | Required | IP address of the Sub-Reseller |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/resellers/generate-login-token.json?auth-userid=0&api-key=key&reseller-id=0&ip=1.1.1.1
Response
Returns a token (String).
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Getting Details of Domain Forwarding Service
Description
Gets details of 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 | Order Id for which details of the Domain Forwarding service need to be fetched |
| include-subdomain | Boolean | Optional | The sub-domain for which details of the Domain Forwarding service need to be fetched |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/domainforward/details.xml?auth-userid=0&api-key=key&order-id=0
Response
Returns a map containing details of the Domain Forwarding service.
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 |
| sub-domain-prefix | String | Optional | The prefix for the sub-domain |
| forward-to | String | Required | URL where you want to forward your request. |
| url-masking | Boolean | Optional | Possible values are true or false. If true passed, visitors will see the source URL and not the destination URL. |
| meta-tags | String | Optional |
Sets META Tags and Page Title for the frames page which is sent to the visitor. eg. <title>Your Webpage title can be mentioned here</title><meta name="keywords" CONTENT="Your comma-separated keywords are entered here"><meta name="description" CONTENT="Enter website description here"> |
| noframes | String | Optional |
Sets alternate <NOFRAMES> page content for search engines. Provide your HTML within <NOFRAMES></NOFRAMES> tags to set alternate page content. |
| sub-domain-forwarding | Boolean | Optional | Possible values are true or false. For e.g. if true passed, a request made to https://subdomain.domainname.com will be forwarded to https://destination-domainname.com/subdomain |
| path-forwarding | Boolean | Optional | Possible values are true or false. For e.g. if true passed, a request made to https://domainname.com/some/path will be forwarded to https://destination-domainname.com/some/path |
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.
Get Customer Pricing
Description
Use this method to get details of the pricing for the Themes, Plugins, Logos for your Customers.
Response
Returns a map with the prices of the Themes, Plugins, Logos along with the prices of the other products.
The response structure for the Themes, Plugins, Logos will be:
"productkey": { "planid": { "action": { "MIN":minimum item price }}, { "MAX":maximum item price }} }
Example:
{"themepluginlogo":{"1321":{"add":{"MIN":0.0,"MAX":81.4}},"1320":{"add":{"MIN":0.0,"MAX":330.0}},"1319":{"add":{"MIN":11.0,"MAX":11000.0}}}}
Get Plan Details
Description
Use this method to get details of your plans.
Response
Returns details of the plans of the Themes, Plugins, Logos, along with the plan details of other Products of the Reseller.
Example:
The response structure for the Themes, Plugins, Logos will be:
"themepluginlogo":
{
"plan-id":
{
"plan_feature":
[
"feature1",
"feature2",
"feature3",
"feature4"
],
"plan_name":"Plan Name",
"plan_status":"(Active or Paused)"
},
},
Search Order and Get Details
Description
Gets the details of an existing Themes, Plugins, Logos Order.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Optional | The OrderId for which the details are to be fetched. |
| domain-name | String | Optional | Domain name for which the details are to be fetched |
| filter | String | Optional | This parameter will filter the orders according to the values provided. Values can be: orderid, domainname, creationtime, planid, productkey, productcategory, currentstatus, entitytypeid, customerid, parentkey, files, item_details |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/restapi/product/themepluginlogo?auth-userid=0&api-key=key&order-id=0&domain-name=domain.com&filter=files&filter=item_details
Response
Returns the details of an existing Themes, Plugins, Logos order.
Add
Description
Places a Themes, Plugins, Logos Order.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| customer-id | Integer | Required | The Customer under whom the Order should be added. |
| plan-id | Integer | Required | The plan under which the Order should be added. To fetch the plan details i.e. plan-id etc., use this method. |
| additional-param-json | String | Required | The licence parameters for the required item. To fetch the details i.e. id etc., use this method.
Note
This should be a valid JSON, containing keys as the item id and license information. |
| 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/restapi/product/themepluginlogo/order?auth-userid=0&api-key=key&customer-id=0&plan-id=0&invoice-option=KeepInvoice&additional-param-json={"id":"57fc0ac0-d508-4ece-b096-041e0a14153b","title":"single-domain"}
Response
Returns a map with the execution details of the Order addition.
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.
/servlet/AutoLoginServlet?userLoginId=XXXXX&role=customer
Note
The token will be valid for a duration of only 120 seconds.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| customer-id | Integer | Required | Customer ID of the Customer |
| ip | String | Required | IP address of the Customer |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/customers/generate-login-token.json?auth-userid=0&api-key=key&customer-id=0&ip=1.1.1.1
Response
Returns a token (String).
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.