Managing DNS, Email, Hosting, Website Builder, SiteLock and CodeGuard through your HTTP API Integration

The following Services reside on separate servers from the ones you connect to, via the HTTP API, due to this, your Customers need to login to their (individual) Control Panels, for managing such Services:

  • DNS

  • Email (<#start free_email#>Free Email Account [POP/IMAP] and <#end free_email#>Email Forwarding)

  • <#start hostingproduct#>

  • Single Domain Hosting

  • Multi Domain Hosting

  • Reseller Hosting

  • Dedicated Server

  • Enterprise Email

  • Business Email

  • Premium DNS

  • <#end hostingproduct#><#start sitelock#>

  • SiteLock

  • <#end sitelock#><#start codeguard#>

  • CodeGuard

  • <#end codeguard#><#start impressly#>

  • Impress.ly

  • <#end impressly#><#start hosting#>

  • Web Services (Legacy Web Hosting, Email Hosting, Website Builder)

  • <#end hosting#>

<%SFNB_RESE123LLER_BRA123ND_NAME%> now provides you with another method of directly allowing access to your Customer, to manage the above Products / Services from your interfaces itself.

To accomplish this, you need to pass the following parameters to the mentioned URL, via an HTTP POST method:

URL: https://<Your_Control Panel_Branded_URL>/servlet/ManageServiceServletForAPI

  • auth-token: You need to generate an authentication token, 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 HTTP API Generating a Token method. The generated authentication token will be valid for a very short period of time and you should use it immediately upon generating it.

  • orderid: The Order ID of the <#start hostingproduct#>Web Services (Legacy Web Hosting, Email Hosting, Website Builder) / Single Domain Hosting / Multi Domain Hosting / Reseller Hosting / Dedicated Server / Managed Server / Enterprise Email / Premium DNS <#end hostingproduct#><#start sitelock#>/ SiteLock <#end sitelock#><#start codeguard#>/ CodeGuard <#end codeguard#>Order that your Customer wants to manage. In case of DNS, Email Service, the Order ID of the Product associated with the DNS / Email Service needs to be passed. Based on the orderid, the productCategory will be determined.

    Note

    For DNS / Email Service 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 Service Management interface respectively.

  • service-name: This parameter needs to be passed to manage the specified service name. The value of this parameter needs to be either:

    • dns: For managing DNS Service.

    • mailfwd: For managing Email Forwarding Service.

    • premiumdns: For managing Premium DNS Service.

    • <#start free_email#>

    • free_email: For managing Free Email Account Service.

    • <#end free_email#><#start hosting#>

    • webhosting: For managing Web Hosting Service.

    • mailhosting: For managing Email Hosting Service.

    • websitebuilder: For managing Website Builder Service.

    • <#end hosting#> <#start impressly#>

    • impressly: For managing an Impress.ly Order.

    • <#end impressly#>

    <#start impressly#>

  • url: This parameter needs to be passed to manage an Impress.ly order. The value of this parameter needs to be a URL on your server that accepts the app-id provided by Impress.ly. You can then retrieve the order details by using the app-id in the Get Callback URL call.

  • <#end impressly#>

    OR

    panel: This parameter needs to be passed to manage WHM. The value of this parameter needs to be whm.

    Note

    For <#start hostingproduct#>Single Domain Hosting / Multi Domain Hosting / Reseller Hosting / Dedicated Server / Managed Server / Enterprise Email <#end hostingproduct#><#start sitelock#>/ SiteLock <#end sitelock#><#start codeguard#>/ CodeGuard <#end codeguard#>Orders, you can pass the corresponding Product Key as the value for this parameter.

    Additional Information

    Product Keys

You would need to create an intermediate interface, which should call the Generating a Token HTTP API method and build a URL with orderid, auth-token and service-name/panel as parameters, and then redirect the Customer to this URL.

Java Example:

Let us call this interface a servlet named ManageOrderBoxControlPanel.

  1. This interface would accept the Order ID of the <#start hostingproduct#>Web Services (Legacy Web Hosting, Email Hosting, Website Builder) / Single Domain Hosting / Multi Domain Hosting / Reseller Hosting / Dedicated Server / Managed Server / Enterprise Email <#end hostingproduct#><#start sitelock#>/ SiteLock <#end sitelock#><#start codeguard#>/ CodeGuard <#end codeguard#>Order or the Order ID of the Service associated with DNS or Email Service as a parameter. So, in order to manage a Service, you will call this interface with https://<Your-Server-URL>/ManageOrderBoxControlPanel?orderid=<orderid>.

  2. This servlet would need to call the Generating a Token HTTP API method.

  3. The final URL to which you would then redirect your Customer to, would look like:

    • For management of WHM: https://<Your_Branded_URL>/servlet/ManageServiceServletForAPI?auth-token=<auth-token>&orderid=<orderid>&panel=whm

    • For management of DNS Service, Email (<#start free_email#>Free Email Account [POP/IMAP] and <#end free_email#>Email Forwarding) Service<#start hostingproduct#>, Web Services (Legacy Web Hosting, Email Hosting, Website Builder), Single Domain Hosting, Multi Domain Hosting, Reseller Hosting, Dedicated Server, Managed Server, Enterprise Email<#end hostingproduct#><#start sitelock#>, SiteLock<#end sitelock#><#start codeguard#>, CodeGuard<#end codeguard#>: https://<Your_Branded_URL>/servlet/ManageServiceServletForAPI?auth-token=<auth-token>&orderid=<orderid>&service-name=<servicename>