|
Managing DNS, Mail Forwarding, Web Hosting, Email Hosting, Live Chat and Website Builder Services through your API integration
The DNS, Mail Forwarding, Web Hosting, Email Hosting,
Live Chat and Website Builder Services reside on separate
servers from the ones you connect to, via the API Kits. Due to this, your
Customers need to login into their (individual) Control Panels, for managing
such Services.
Whois.com Pte Ltd now provides you with another method of
directly allowing access to your Customer, to manage their DNS, Mail
Forwarding, Web Hosting, Email
Hosting, Live Chat and Website Builder Services from your interfaces itself.
To accomplish this, you need to use either
of these 2 methods and pass the following parameters to the mentioned URL,
via an HTTP POST method:
Method 1 (recommended)
URL -
http://<Your_Control Panel_Branded_URL>/servlet/ManageServiceServletForAPI
- orderid - The Web Hosting/Email Hosting/Live
Chat/Website Builder Service Order Id that your Customer wants to manage.
In case of DNS/Mail Forwarding Service, the Order ID of the Product associated with the
DNS/Mail Forwarding Service needs to be passed. Based on the orderid, the
productCategory will be determined.
IMPORTANT
* For DNS
and Mail Forwarding Orders that do not have any other Product associated with them, you can continue to pass the existing
orderid to reach the DNS Management Console and Email Forwarding
Management interface respectively.
- loginid - You need to generate a Login ID, that you need to pass
as the value of this parameter for allowing the Customer to manage his
Order. This can be accomplished by calling the API method generateLoginID
in the Customer class. In order to call generateLoginID, you will have
to pass ipAddress as a parameter. This Login ID generated will be
valid for a very short period of time and you should use it immediately upon
generating it.
IMPORTANTWhile generating the Login ID, you need to use
the Username and Password of the Customer, to whom the Order belongs.
- viewdns - This parameter needs to be passed to manage the DNS
Service. The value of this parameter can be either true
or false. If you do not pass any value for this parameter, then it is
interpreted as false.
Based on the orderid and
viewdns parameters, the following interfaces will be displayed:
|
productCategory |
viewdns set to true |
viewdns set to false |
|
domorder |
DNS Management Console |
DNS Management Console |
|
dnsbox* |
DNS Management Console |
DNS Management Console |
|
hosting |
DNS Management Console |
Hosting Control Panel |
|
mailbox |
DNS Management Console |
Mailbox Control Panel |
|
sitebuilder |
DNS Management Console |
SiteBuilder Interface |
|
livehelp |
DNS Management Console |
Livehelp Interface |
|
digicert |
DNS Management Console |
DNS Management Console |
- product - This parameter needs to be passed to manage the Mail
Forwarding Service. The value of this parameter needs to be mailfwd.
This method is the most secure method of
allowing your Customers to manage their DNS, Mail Forwarding, Web Hosting, Email Hosting,
Live Chat and Website Builder Services, since it does not expose the Customer's Username
and Password in your interface.
If you choose to use this method, then you
would need to create an intermediate interface to which you can provide the
required parameters, and which in-turn generates a valid URL and redirects your
Customer.
You need to provide orderid and any
authentication details (optional) to this interface. This interface would
then call the API method generateLoginID of the Customer class and build
a URL with orderid and loginid as parameters, and
then redirect the Customer
to this URL. In case of DNS Service, the URL will have the additional parameter
viewdns and the additional parameter mailfwd in case of Mail
Forwarding Service.
Example
Let us call this interface a servlet named
ManageOrderBoxControlPanel (assuming that you are using our JAVA API Kit).
- This interface would accept Web Hosting/Email Hosting/Live Chat/Website Builder
Service Order Id or the Order Id of the Product associated with DNS
or Mail Forwarding Service as a parameter. So, in order to manage a Service, you will
call this interface with http://<Your-Server-URL>/ManageOrderBoxControlPanel?orderid=<orderid>.
- Now this servlet would need to call the API
method generateLoginID
of the Customer class like -
String loginid = API call to "generateLoginID(username,password,resellerid,langpref,role,ipAddress) ;
where,
- username - the Username of the
Customer, to whom the Order belongs
- password - the Password of the
Customer, to whom the Order belongs
- resellerid - the Reseller Id
associated with your Reseller account. This is obtainable from Settings ->
Personal Information -> Primary Profile in your Reseller Control Panel.
- role - customer
- The final URL to which you would then redirect
your Customer to, would look like -
http://<Your_Branded_URL>/servlet/ManageServiceServletForAPI?loginid=<loginid>&orderid=<orderid>
(in case of Web Hosting/Email Hosting/Live Chat/Website Builder Services)
http://<Your_Branded_URL>/servlet/ManageServiceServletForAPI?loginid=<loginid>&orderid=<orderid>&viewdns=<true/false>
(in case of DNS Service)
http://<Your_Branded_URL>/servlet/ManageServiceServletForAPI?loginid=<loginid>&orderid=<orderid>&product=mailfwd
(in case of Mail Forwarding Service)
Method 2
URL -
http://<Your_Control Panel_Branded_URL>/servlet/ManageServiceServletForAPI
- orderid - The Web Hosting/Email Hosting/Live Chat/Website Builder
Service Order Id that your Customer wants to manage.
In case of DNS/Mail Forwarding Service, the Order ID of the Product associated with the
DNS/Mail Forwarding Service needs to be passed. Based on the orderid, the
productCategory will be determined.
IMPORTANT
* For DNS and Mail Forwarding Orders that do not have any other Product associated with them, you can continue to pass the existing
orderid to reach the DNS Management Console and Email Forwarding
Management interface respectively.
- username - The Username of the Customer, to whom the Order
belongs
- password - The Password of the Customer, to whom the Order
belongs
- resellerid - The Reseller Id associated with your Reseller account. This
is obtainable from Settings ->
Personal Information -> Primary Profile in your Reseller Control Panel.
- viewdns - This parameter needs to be passed to manage the DNS
Service. The value of this parameter can be either true
or false. If you do not pass any value for this parameter, then it is
interpreted as false.
More details >>
- product - This parameter needs to be passed to manage the Mail
Forwarding Service. The value of this parameter needs to be mailfwd.
The disadvantage of using this method is that
it is a bit less secure as the Customer Username and Password along with your
Reseller Id can be viewed in the source of the page, from where you post to the
ManageServiceServletForAPI servlet.
IMPORTANT
Do not send the above mentioned as parameters
as part of a URL, or else this information will be displayed in your
Customer's Browser Address Bar.
|