reseller

is added when reseller has a customer specific business

Paid Privacy Protection Setup

You may offer Privacy Protection as a paid or a free service. If you were previously offering privacy protection as a free service and wish to continue it, no changes are required on your part except setting your Selling Price for Privacy Protection to zero. However, if you wish to start charging for it, you will have to make the below changes to support this change.

Setting your Selling Price (After launch of Paid Privacy Protection)

  1. Login to your Control Panel.

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

  3. Click the Domain Registration link

  4. Under the Add-On Services section, click the Manage Prices link next to Privacy Protection.

  5. Mention your Selling Price for your Customers and Sub-Resellers in the appropriate fields.

  6. Click the Update Pricing button.

SuperSite Changes

  • Updates to existing files

    • Products -> Domain -> Domain_registration -> Check_availability_new -> Domain_search_result.html

    • Products -> Domain -> Premium_domain -> Premiumdomain.html

    • Products -> Domain -> Domain_registration -> Check_availibilty -> Includes -> Idn_domain_search_blurb.html

    If you have made any modifications to these files, you need to update them to include the changes related to Paid Privacy Protection service.

  • Newly introduced files

    • Products -> Domain -> Domain_registration -> Check_availibilty -> Privacy_protect_modal.html

    • Products -> Domain -> Common -> Privacy_protect_landing_page.html

API Changes

Below changes to the API calls need to implemented:

  • Domain Registration and Domain Transfer: If you wish to purchase Privacy Protection when registering or transferring a domain name, your Registration or Transfer API call must include an additional parameter purchase-privacy with the value true. This will ensure that the service is purchased for the same term as the domain name. You can continue to use the existing parameter privacy-protect with the value true as long as your Selling Price to Customers in our system is set to zero. However, do keep in mind that your Reseller Account will be charged for the service.

    Sample Registration Call for Paid Privacy Protection (Selling Price to Customers is set to non zero in our system)

    https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=NoInvoice&purchase-privacy=true

    Sample Registration Call for Free Privacy Protection (Selling Price to Customers is set to zero in our system) [Existing API call]

    https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=NoInvoice&protect-privacy=true

    Sample Transfer Call for Paid Privacy Protection (Selling Price to Customers is set to non zero in our system)

    https://test.httpapi.com/api/domains/transfer.xml?auth-userid=0&api-key=key&domain-name=domain.com&auth-code=auth-code&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=NoInvoice&purchase-privacy=true

    Sample Transfer Call for Free Privacy Protection (Selling Price to Customers is set to zero in our system) [Existing API call]

    https://test.httpapi.com/api/domains/transfer.xml?auth-userid=0&api-key=key&domain-name=domain.com&auth-code=auth-code&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=NoInvoice&protect-privacy=true

  • Domain Renewal: If the Privacy Protection service is expiring before or along with the domain name, it can be extended along with the domain name itself. For this, the Renewal API call must include the additional parameter purchase-privacy with the value true.

    Sample Renewal Call for Paid Privacy Protection (Selling Price to Customers is set to non zero in our system)

    https://test.httpapi.com/api/domains/renew.xml?auth-userid=0&api-key=key&order-id=562994&years=1&exp-date=1279012036&invoice-option=NoInvoice&purchase-privacy=true

    Sample Renewal Call for Free Privacy Protection (Selling Price to Customers is set to zero in our system) [Existing API call]

    https://test.httpapi.com/api/domains/renew.xml?auth-userid=0&api-key=key&order-id=562994&years=1&exp-date=1279012036&invoice-option=NoInvoice

  • Purchasing / Renewing Privacy Protection for an existing Domain Name: Before enabling the Privacy Protection service for a domain name, it must be purchased for the domain name. This must be done using the Purchase Privacy API call, which will add and activate the service for the domain name until its expiration date. The same call can be used to renew the Privacy Protection service if it expires before the expiration of the domain name itself.

    Sample Purchase Call for Paid Privacy Protection (Selling Price to Customers is set to non zero in our system)

    https://test.httpapi.com/api/domains/purchase-privacy.xml?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice

    Sample Activation Call for Free Privacy Protection (Selling Price to Customers is set to zero in our system) [Existing API call]

    https://test.httpapi.com/api/domains/modify-privacy-protection.xml?auth-userid=0&api-key=key&order-id=0&protect-privacy=true&reason=somereason

Dedicated Server Linux

The pricing model of the Dedicated Server Linux 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.

Set Dedicated Server Linux Plans Selling Price (Anchor: plans)

firstfoot Interactive Pvt Ltd. allows you to set Telescopic Price ranges for all Dedicated Server Linux 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 Dedicated Server Linux Orders with you for multiple months.

Example:

Suppose that your Cost Price for Plan DS1 is USD 5 per month. Depending upon your business model, you may set your Selling Price for 6 months as USD 10 per month. Now, if a Customer
wished to add a Hosting Order under Plan DS1 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 Dedicated Server Linux 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 Dedicated Server Linux link.

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

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

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

  7. You may choose to add additional slabs for the duration of the Plan, by selecting it from the drop-down at the bottom of the page and clicking Add Slab.

  8. Click the Update button to save your changes.

To Set your Dedicated Server Linux Add-ons 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 Dedicated Server Linux link.

  4. Click the Manage Price link under the Action column in the Add-ons section.

  5. Mention the per month Selling Price for each Add-on as per your requirement.

    Note

    Selling Price set for an Add-on would be applicable across all Slabs created for all the Dedicated Server Linux Plans.

  6. Click the Update button to save your changes.

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

  • If you have multiple slabs configured, you need to set reduced pricing for the higher duration slab, than the one that is immediately of a lower duration.

    Example:

    If you have a Selling Price For 3 Months slab and add a Selling Price For 12 Months slab, then the per month Selling price you need to mention for the 12 Months slab needs to be lower
    than that of the 3 Months slab.

  • 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. The cache of your SuperSite and PartnerSite will be reloaded automatically, once you have completed the above process. This way, the updated details will be downloaded to your SuperSite and PartnerSite from your Control Panel.

    Additional Information

    SuperSite

    PartnerSite

Dedicated Server Linux Setup Guide

As a Reseller, you need to take the following steps in order to start selling the Dedicated Server Linux Product to your Customers and Sub-Resellers:

  • Ensure that you are Selling the Dedicated Server Linux
    Product. See details

  • Select which Plans to display on your SuperSite. See details

  • If Tax is applicable to the Dedicated Server Linux Product in your Country, you may use our Tax Engine to collect it from your Customers and
    Sub-Resellers. See details

Get Reseller Pricing

Description

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

Response

Returns a map with the prices of the Dedicated Server Linux plans along with the prices of the other products.

The response structure for the Dedicated Server Linux product will be:


"productkey":
{
"addons":
{
"addon1-name":price,
"addon2-name":price
},
"plans":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
}
}
}

Example:


US Server

"dedicatedserverlinuxus":
{
"addons":
{
"storage_1":0.0,
"cpanel":0.0,
"whmcs":0.0,
"ipaddress":0.0,
"storage_5":0.0,
"storage_4":0.0,
"storage_3":0.0,
"storage_2":0.0
},
"plans":
{
"105":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
},
"106":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
}
}
}

Get Customer Pricing

Description

Use this method to get details of the pricing for the Dedicated Server Linux plans for your Customers.

Response

Returns a map with the prices of the Dedicated Server Linux plans along with the prices of the other products.

The response structure for the Dedicated Server Linux product will be:


US Server

"productkey":
{
"addons":
{
"addon1-name":price,
"addon2-name":price
},
"plans":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
}
}
}

Example:


"dedicatedserverlinuxus":
{
"addons":
{
"storage_1":0.0,
"cpanel":0.0,
"whmcs":0.0,
"ipaddress":0.0,
"storage_5":0.0,
"storage_4":0.0,
"storage_3":0.0,
"storage_2":0.0
},
"plans":
{
"105":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
},
"106":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
}
}
}

Search Orders

Description

Gets a list and details of the Dedicated Server Linux 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 Dedicated Server Linux Order(s) whose details need to be fetched
reseller-id Array of Integers Optional Reseller ID(s) whose Dedicated Server Linux Orders need to be fetched
customer-id Array of Integers Optional Customer ID(s) whose Dedicated Server Linux 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 Dedicated Server Linux Order
creation-date-start String Optional UNIX TimeStamp for listing of the Dedicated Server Linux Orders whose Creation Date is greater than creation-date-start
creation-date-end String Optional UNIX TimeStamp for listing of the Dedicated Server Linux Orders whose Creation Date is less than creation-date-end
expiry-date-start String Optional UNIX TimeStamp for listing of the Dedicated Server Linux Orders whose expiry date is greater than expiry-date-start
expiry-date-end String Optional UNIX TimeStamp for listing of the Dedicated Server Linux 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


US Server

https://test.httpapi.com/api/dedicatedserver/linux/us/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 Dedicated Server Linux 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)

  • Type of Operating System (hosting_group_info.os_type)

  • Data Center location for the Managed Server (hosting_group_info.location)

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 Dedicated Server Linux 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


US Server

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

Response

Returns the associated Dedicated Server Linux 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 Dedicated Server Linux product, along with the plan details of other Products of the Reseller.

Example:

The response structure for the Dedicated Server Linux product will be:


US Server

"dedicatedserverlinuxus":
{
"plan-id":
{
"supported_os":
[
{
"os_display_name":"OS Display Name",
"os_name":"OS Name",
"addons":
[
{
"addon_name":"storage_1",
"type":"SATA",
"is_paid":(true or false),
"space":51200,
"free_quantity":0,
"conflicting_addon_names":[]
},
{
"addon_name":"storage_2",
"type":"SATA",
"is_paid":(true or false),
"space":102400,
"free_quantity":0,
"conflicting_addon_names":[]
},
{
"addon_name":"storage_3",
"type":"SATA",
"is_paid":(true or false),
"space":204800,
"free_quantity":0,
"conflicting_addon_names":[]
},
{
"addon_name":"storage_4",
"type":"SATA",
"is_paid":(true or false),
"space":307200,
"free_quantity":0,
"conflicting_addon_names":[]
},
{
"addon_name":"storage_5",
"type":"SATA",
"is_paid":(true or false),
"space":512000,
"free_quantity":0,
"conflicting_addon_names":[]
},
{
"addon_name":"ipaddress",
"is_paid":(true or false),
"free_quantity":2,
"conflicting_addon_names":[]
},
{
"addon_name":"cpanel",
"is_paid":(true or false),
"free_quantity":0,
"conflicting_addon_names":[]
},
{
"addon_name":"whmcs",
"is_paid":(true or false),
"free_quantity":0,
"conflicting_addon_names":[]
}
],
"is_default"(true or false)
}
],
"plan_name":"Plan Name",
"bandwidth":value,
"ram":
{
"ram_memory":value,
"ram_type":"RAM Type"
},
"storage":
{
"storage_raid_level":value,
"storage_space":value,
"storage_type":"SATA"
},
"cpu":
{
"cpu_speed":"value",
"cpu_hyper_threaded":(true or false),
"cpu_processor_type":"Processor Type",
"cpu_cores":value
}
}
}

Get Details

Description

Gets the details of an existing Dedicated Server Linux 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 for which the details to be fetched

HTTP Method

GET

Example Test URL Request


US Server

https://test.httpapi.com/api/dedicatedserver/linux/us/details.json?auth-userid=0&api-key=key&order-id=0


Response

Returns a hash map containing the below details:

  • Order ID (entityid)

  • Order Description (description)

  • Domain Name (domainname)

  • Current Order Status under the System (currentstatus) - value will be InActive, Active, Suspended or Deleted

  • Product key (productkey)

  • Product Category (productcategory)

  • Order Creation Date (creationtime)

  • Expiry Date (endtime)

  • Whether Order belongs to a Customer directly under the Reseller (isImmediateReseller)

  • Reseller Chain by RID (parentkey)

  • Customer ID Associated with the Order (customerid)

  • Whether Order Suspended due to Expiry (isOrderSuspendedUponExpiry)

  • Whether Order Suspended by Parent Reseller (orderSuspendedByParent)

  • Whether Order Deletion is Allowed (allowdeletion)

  • Cost Price for Reseller (resellercost)

  • Cost Price for Customer (customercost)

  • IP Address (ipaddress)

  • Plan ID of the Dedicated Server Plan (planid)

  • Status of the Dedicated Server Plan (paused)

  • Admin User for the Dedicated Server Order (siteadminusername)

  • Password for the above Admin USer (siteadminpassword)

  • Installed Operating System (os_name)

  • Details of the Addons (addons)

    • Addon ID of the Addon (addon_id)

    • Addon Name (addon_name)

    • Addon Creation Date (creation_time)

    • Payment Status for the Addon (is_paid)

    • IP Address (ipaddress)

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