reseller

is added when reseller has a customer specific business

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.

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.

The Express Cart

The Express Cart is a power tool that is specially designed to help Resellers place Orders on behalf of their Customers. It encapsulates the purchase process in 3 simple steps and allows for easier and faster Order processing.

The Express Cart can be reached by clicking on the Buy button in the Reseller Control Panel on the top right. Alternatively, all Buy links within the Products menu default to the Express Cart for Resellers.

You can switch to SuperSite2 through the Go to Supersite >> link in the Express Cart tool.

You can place Orders within seconds through the Express Cart by simply:

  1. Selecting a Product

  2. Specifying the Customer information

  3. Selecting an Invoice option for this Customer

Selecting a Product

All the Products that you currently offer will be available within the drop down.

Note

Currently, the following Products are not supported in the Express Cart:

  • Dedicated Servers

With the Express Cart, you can place a single Order at a time.

Domain Registration

The tool offers the essentials in terms of Domain Registration, where you can search for your desired keywords and extensions. You can choose to add Privacy Protection to the Order, as well.

Note

You must go to your SuperSite/custom Storefront if you want to:

  • see suggestions for your domain name

  • register Internationalized Domain Names (IDNs)

  • register domains under TLDs that require special nexus information

  • register premium names

  • register / transfer domain names in bulk

The default Name servers and Contact details are automatically used for domain registration.

Note

Make sure to Reload Your Cost Prices every time your Parent changes them. This way, you will be able to see your updated Cost Prices in the Express Cart.

Applying Discounts

For every Order, you can apply desired discounts in the cart itself. You can either enter an amount or a percentage.

  • If a discount is applied to the Order, a Credit Note for the corresponding amount is added to the Customer's account.

  • If a Product is already on promotion, the Reseller can still apply an additional discount. In this case, a similar Credit Note will be created.

Adding Funds

In case you are short on funds, you can click on the Add Funds link to replenish your balance. Once done, make sure to hit the Refresh Balance link so that your new balance gets updated on the Express Cart.

Specifying the Customer Information

Here, you can simply enter the email address of the Customer you are purchasing this Product for. If it is a new Customer, click on the Create Account button and add the necessary details to create a new Customer account.

Selecting an Invoice Option

You can either choose to cancel the Invoice or leave it pending for your Customer, by selecting one of these options:

  • Cancel Invoice - This will reverse the Invoice after creating it, by automatically adding a sales reversal Credit Note for the same amount. You can use this option when you’re using the system for billing, but collecting funds offline. This way, you can always keep track of your sales transactions and discounts, without having your Customer pay for the Invoice in the system.

  • Keep Invoice pending - This will create the Invoice and keep it pending till your Customer doesn’t pay for it in the system. You can use this option when you’re collecting funds online and require to suspend the Order, in case your payment doesn’t come through.

Once you place the Order, your total cost will automatically be deducted from your Account Balance and the Order will be activated for your Customer. System notifications will be sent to you and your Customer, as per your Email preferences.

CodeGuard

The pricing model of the CodeGuard Product is based on discounts, depending on the number of months an Order is purchased and renewed for. This feature is referred as Telescopic Pricing.

Set CodeGuard Plans Selling Price (Anchor: plans)

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

Example:

Suppose that your Cost Price for Plan CG1 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 CodeGuard 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 CodeGuard 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.

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 6 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 6 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 Sub-Resellers respectively. Once you have updated your Prices, the changes are reflected on your SuperSite and PartnerSite automatically.

    Additional Information

    SuperSite

    PartnerSite

CodeGuard Setup Guide

As a Reseller, you need to set up the following from within your Reseller Control Panel in order to start selling the CodeGuard Product to your Customers and Sub-Resellers:

  • Activate the CodeGuard Product for your Reseller Account. See details

  • Set your Selling Price for the CodeGuard Product. See details

  • If Tax is applicable to the CodeGuard 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 CodeGuard plans for your Sub-Resellers.

Response

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

The response structure for the CodeGuard product will be:


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

Example:


"codeguard":
{
"plans":
{
"229":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
},
"230":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
}
"231":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
}
"232":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
}
}
}

Get Customer Pricing

Description

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

Response

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

The response structure for the CodeGuard product will be:


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

Example:


"codeguard":
{
"plans":
{
"229":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
},
"230":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
}
"231":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
}
"232":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
}
}
}

Search Orders

Description

Gets a list and details of the CodeGuard 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 IDs of the CodeGuard Orders whose details need to be fetched
reseller-id Array of Integers Optional Reseller IDs whose CodeGuard Orders need to be fetched
customer-id Array of Integers Optional Customer IDs whose CodeGuard 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 CodeGuard Order
creation-date-start String Optional UNIX TimeStamp for listing of the CodeGuard Orders whose Creation Date is greater than creation-date-start
creation-date-end String Optional UNIX TimeStamp for listing of the CodeGuard Orders whose Creation Date is less than creation-date-end
expiry-date-start String Optional UNIX TimeStamp for listing of the CodeGuard Orders whose expiry date is greater than expiry-date-start
expiry-date-end String Optional UNIX TimeStamp for listing of the CodeGuard 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/codeguard/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 CodeGuard 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 CodeGuard 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/codeguard/orderid.json?auth-userid=0&api-key=key&domain-name=domainname.com

Response

Returns the associated CodeGuard Order ID (Integer) for the specified domain name.

Get Plan Details

Description

Use this method to get details of your plans.

Response

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

Example:

The response structure for the CodeGuard product will be:


"codeguard":
{
"plan-id":
{
"plan_name":"Plan Name",
"plan_status":"(Active or Paused)"
},
},