sitelock

Reseller should be signed up for the SiteLock product

Add

Description

Places a SiteLock Order for the specified 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 to be placed
customer-id Integer Required The Customer under whom the Order should be added
plan-id Integer Required The plan under which the Order should be added. To fetch the plan details i.e. plan-id etc., use this method.
auto-renew Boolean Optional

Enables / Disables the Auto Renewal setting for the Order

invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/sitelock/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&plan-id=0&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the SiteLock Order (entityid)

  • Action Type (actiontype)

  • Description of the SiteLock Order Add Action (actiontypedesc)

  • Action ID of the SiteLock Order Add Action (eaqid)

  • SiteLock Order Add Action Status (actionstatus)

  • Description of the SiteLock Order Add Action Status (actionstatusdesc)

  • Invoice ID of the SiteLock Order Add Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the SiteLock Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

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

SiteLock Setup Guide

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

  • Under the Status section, ensure that you are set to Sell SiteLock. See details

  • Set your Selling Price for SiteLock. See details

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

SiteLock

A SiteLock Order can be purchased / renewed for a duration of 12 months only. Hence, you can set Pricing for SiteLock Product for 12 months duration only.

Set SiteLock Plans Selling Price (Anchor: plans)

To Set your SiteLock Plans 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 SiteLock link.

  4. Your Customer Pricing is available under the Customers tab. To set Pricing for Sub-resellers, click the Sub-Resellers tab.

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

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

  7. 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.

  • 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

IMPORTANT: SiteLock User Guide

This article explains the various functionalities available within the SiteLock Panel. See details

On logging in to your SiteLock Panel, you will see the following sections:

Visitor Data

Here, you can filter the visitor data based on specific duration as well as specific website.

Security Summary

This section displays the various types of scans available and their status for your website. You can also initiate scans from here.

Messages and Alerts

This section displays messages / alerts generated by the scans on your website.

You can jump to this section by clicking the icon as shown below.

SiteLock Badge or TrustSeal

You can display the SiteLock TrustSeal on your website through the below link which appears in the lower section of your SiteLock Dashboard.

Additional Information

TrustSeal

Business Verification

You can complete the Business Verification for your website, to display these details in your TrustSeal.

Additional Information

Business Verification

Sites

For quick management, you can toggle between the websites configured under your SiteLock Panel as shown below.

FTP Settings

In order to use the Secure Malware Alert and Removal Tool (SMART), you can input / edit your FTP settings as shown below. (This scan is not available in the lowest Plan.)

These details can also be submitted through the Configure SMART link in the Security Summary section.

TrueShield Firewall / TrueSpeed CDN

In order to block bad traffic and increase your website speed, it is recommended that you configure TrueShield Firewall / TrueSpeed CDN for your website. This can be done through the TrueShield details link in the Security Summary section on your Dashboard.

Additional Information

TrueShield Firewall

TrueSpeed CDN

Accessing your SiteLock Order

SiteLock Panel is an interface that allows you to access and manage your SiteLock Package (manage websites, initiate scans, view reports, etc.). You can access the SiteLock Panel as below:

  1. Login to your Control Panel, Search for the domain name for which you have purchased this SiteLock Order and go to the
    Order Information view. See details

  2. Click the Admin Panel link to visit the SiteLock Panel.

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 (Free Email Account [POP/IMAP] and Email Forwarding)

  • Single Domain Hosting

  • Multi Domain Hosting

  • Reseller Hosting

  • Dedicated Server

  • Enterprise Email

  • Business Email

  • SiteLock

  • CodeGuard

  • Impress.ly

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

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 Web Services (Legacy Web Hosting, Email Hosting, Website Builder) / Single Domain
    Hosting / Multi Domain Hosting / Reseller Hosting / Dedicated Server / Managed Server / Enterprise Email / SiteLock / 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.

    • free_email: For managing Free Email Account Service.

    • webhosting: For managing Web Hosting Service.

    • mailhosting: For managing Email Hosting Service.

    • websitebuilder: For managing Website Builder Service.


    • impressly: For managing an Impress.ly Order.

  • 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.

  • OR

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

    Note

    For Single Domain
    Hosting / Multi Domain Hosting / Reseller Hosting / Dedicated Server / Managed Server / Enterprise Email / SiteLock / 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 Web Services (Legacy Web Hosting, Email Hosting, Website Builder) / Single Domain
    Hosting / Multi Domain Hosting / Reseller Hosting / Dedicated Server / Managed Server / Enterprise Email / SiteLock / 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 (Free Email Account [POP/IMAP] and Email Forwarding) Service, Web Services (Legacy Web Hosting, Email Hosting, Website Builder), Single Domain Hosting, Multi Domain Hosting, Reseller Hosting, Dedicated Server, Managed Server, Enterprise Email, SiteLock, CodeGuard:
      https://<Your_Branded_URL>/servlet/ManageServiceServletForAPI?auth-token=<auth-token>&orderid=<orderid>&service-name=<servicename>