reseller

is added when reseller has a customer specific business

Business Email

The pricing model of the Business Email Product is based on discounts, depending on the number of months any Plan's Order is purchased
and renewed for
. This feature is referred as Telescopic Pricing.

Note

Set Business Email Plans Selling Price (Anchor: plans)

allows you to set Telescopic Price ranges for all Business Email Adds and Renewals for each Plan.
This simply means that you may offer your Customers and Sub-Resellers increased discounts as and when they may choose to add / renew their Business Email Orders with you for multiple months.

Example:

Suppose that your Cost Price for Plan A is USD 5 per month. Depending upon your business model, you may set your Selling Price for 12 months as USD 10 per month. Now, if a Customer
wished to add a Hosting Order under Plan A for 12 months, he would be charged USD 120 (USD 10 per month). However, with the Telescopic Pricing model, you may set a reduced price of say,
USD 8 per month. In this way, your Customer is charged USD 96 instead of USD 120, thus, availing a discount for purchasing for a longer duration.

To Set your Business Email Plans Telescopic Selling Price

  1. Login to your Control Panel. See details

  2. In the Menu, point to Settings and click Manage Products and Pricing.

  3. Click the Business Email link.

  4. Click any Geo Hosting tab to set Pricing for Plans under that Geo Hosting.

  5. Click the Customers tab to set the Customer Pricing and the Sub-Resellers tab to set the Sub-Reseller Pricing.

  6. Click the Manage Price link under the Action column besides any Plan.

  7. Mention the per month Selling Price in each text box as per your requirement.

  8. Click the Update button to save your changes.

Note
  • You need to set Pricing for Plans under each Geo Hosting that you have signed up for.

  • Price can be any number (upto 2 decimal places). Hence, 3.00, 3, 3.19 are all valid prices.

  • You need to set reduced pricing for the higher duration slab, than the one that is immediately of a lower duration.

    Example:

    The per month Selling price you need to mention for the 6 Months slab needs to be lower than that of the 3 Months slab.

  • When Specific Pricing is not set, then your Customer would get the best pricing from amongst the Telescopic Pricing (for Business Email) and any ongoing Promotion
    Pricing (if applicable)
    .

    Additional Information

    Understanding Specific Pricing

  • A Plan Name can be customized by clicking the Edit link next to it and submitting a new Plan Name. Plan Name of existing Orders will be updated to reflect the new Plan Name.

  • The SuperSite and PartnerSite contain Pricing information about the Products and Services you offer to your Customers and Resellers respectively. This data is downloaded to your SuperSite
    and PartnerSite from your Control Panel and cached (stored) on the SuperSite and PartnerSite server respectively. Hence, you would need to refresh the cache of your SuperSite and PartnerSite
    once you have completed the above process. You can accomplish this from within your Control Panel itself by pointing to Tools ->
    Reload SuperSite & PartnerSite Cache in the Menu and clicking All SuperSite & PartnerSite Settings.

    Additional Information

    SuperSite

    PartnerSite

Process Threat Notifications

Description

Processes the specified threat notifications.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
notification-id Array of Integers Required Notification ID of the threat notifications which needs to be processed. Use this method to get the Notification ID(s).
reseller-id Integer Optional Reseller ID of the Reseller for whom threat notifications are to be processed. By default, threat notifications for the current user will be processed.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/sitelock/threat/processed.json?auth-userid=0&api-key=key&notification-id=0

Response

Returns true (String) if the threat notification(s) is/are processed successfully.

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

Get Threat Notifications

Description

Gets a list of pending threat notifications.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
reseller-id Integer Optional Reseller ID of the Reseller for whom threat notifications are to be retrieved. By default, threat notifications for the current user will be retrieved.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/sitelock/threat/pending.json?auth-userid=0&api-key=key

Response

Returns a hash map containing the below details:

  • Customer ID of the Customer for whom threat notifications are pending (customerId)

    • Domain name for which threat notifications are pending (domainName)

      • Creation time for the threat notification (creationTime)

      • Notification ID associated with the threat notification (notificationId)

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

The response structure will be:


{
"account":
[
{
"customerId":0,
"website":
[
{
"domainName":"domain1.com",
"notification":
[
{
"creationTime":1398758909871,
"notificationId":2
}
]
},
{
"domainName":"domain2.com",
"notification":
[
{
"creationTime":1398759150807,
"notificationId":3
}
]
}
]
},
{
"customerId":1,
"website":
[
{
"domainName":"domain3.com",
"notification":
[
{
"creationTime":1398759334814,
"notificationId":4
}
]
}
]
}
]
}

Handle Threat Notifications

The OrderBox system sends out SiteLock threat notification emails to your Customers, if the Product Mails have been enabled for them. However, the Customers will not be notified of the threats if these mails are disabled for them. You need to handle the threat notifications as explained below in such cases:

  1. Fetch a list of pending threat notifications from the OrderBox system.

  2. Run a cron to send out mail alerts to your Customers, based on the data received from step 1.

  3. Use the Notification ID(s) received from step 1 to inform the OrderBox system that Customers have been notified about the specified threats.

Get Reseller Pricing

Description

Use this method to get details of the pricing for the SiteLock plans for your Sub-Resellers.

Response

Returns a map with the prices of the SiteLock plans along with the prices of the other products.

The response structure for the SiteLock product will be:


"productkey":
{
"plans":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
}
}
}

Example:


"sitelock":
{
"plans":
{
"178":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
},
"179":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
}
"180":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
}
"181":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
}
}
}

Get Customer Pricing

Description

Use this method to get details of the pricing for the SiteLock plans for your Customers.

Response

Returns a map with the prices of the SiteLock plans along with the prices of the other products.

The response structure for the SiteLock product will be:


"productkey":
{
"plans":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
}
}
}

Example:


"sitelock":
{
"plans":
{
"178":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
},
"179":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
}
"180":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
}
"181":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
}
}
}

Search Orders

Description

Gets a list and details of the SiteLock Orders matching the search criteria.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
no-of-records Integer Required Number of Orders to be fetched
page-no Integer Required Page number for which details are to be fetched
order-id Array of Integers Optional Order ID(s) of the SiteLock Order(s) whose details need to be fetched
reseller-id Array of Integers Optional Reseller ID(s) whose SiteLock Orders need to be fetched
customer-id Array of Integers Optional Customer ID(s) whose SiteLock Orders need to be fetched
show-child-orders Boolean Optional Whether Sub-Reseller Orders need to be fetched or not
status Array of Strings Optional Status of the Order: Active, InActive, Suspended or Deleted
domain-name String Optional Name of the Domain of the SiteLock Order
creation-date-start String Optional UNIX TimeStamp for listing of the SiteLock Orders whose Creation Date is greater than creation-date-start
creation-date-end String Optional UNIX TimeStamp for listing of the SiteLock Orders whose Creation Date is less than creation-date-end
expiry-date-start String Optional UNIX TimeStamp for listing of the SiteLock Orders whose expiry date is greater than expiry-date-start
expiry-date-end String Optional UNIX TimeStamp for listing of the SiteLock Orders whose expiry date is less than expiry-date-end
order-by Array of Strings Optional One or more parameters by which you want to sort the Orders. Default is orderid.

Example:

If page-no is 1, no-of-records is 30 and order-by is orderid; it will fetch the first 30 Orders which suit the search criteria sorted by orderid.
If page-no is 2, no-of-records is 30 and order-by is orderid; it will fetch the second batch of 30 Orders sorted by orderid.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/sitelock/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1

Response

Returns a hash map containing the below details of the SiteLock Orders which match the search criteria:

  • Domain Name (entity.description)

  • Order Id (orders.orderid)

  • Customer Id (entity.customerid)

  • Order Creation Timestamp (orders.creationtime)

  • Order Expiry Timestamp (orders.endtime)

  • Current Order Status (entity.currentstatus) - value will be InActive, Active, Suspended or Deleted

  • Product Name (entitytype.entitytypename)

  • Product Key (entitytype.entitytypekey)

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

Get Order Id

Description

Gets the associated SiteLock Order ID from the 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 The domain name for which the Order ID is to be fetched

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/sitelock/orderid.json?auth-userid=0&api-key=key&domain-name=domainname.com

Response

Returns the associated SiteLock Order ID (Integer) of the domain name.

Get Plan Details

Description

Use this method to get details of your plans.

Response

Returns details of the plans of the SiteLock product, along with the plan details of other Products of the Reseller.

Example:

The response structure for the SiteLock product will be:

"sitelock":
	{
		"plan-id":
			{
				"plan_features":
					[
						"feature1",
						"feature2",
						"feature3",
						"feature4"
					],
				"plan_name":"Plan Name",
				"plan_status":"(Active or Paused)"
			},
	},