Dashboard integration overview

This section outlines how to pull SiteLock scan status information into an application hosted by the partner through the API.

SiteLock provides API methods for:

  • Retrieving results of scans

  • Managing SSL Monitor

  • Managing the SiteLock shield

  • Triggering scans

  • Retrieving system messages

The API endpoint is:

https://api.sitelock.com/v1/partner

Retrieving results of scans

There are three general approaches that you can take to retrieve the results of your scans:

  1. You maintain a list of SiteLock account ID values and retrieve the list of sites associated with an account (along with their associated compliance status values) from SiteLock. You allow the user to specify a listed site for which they want to view details. This integration is achieved through two methods:

    1. getStatus to retrieve a list of sites and users for a given account, and the compliance status of sites

    2. scanInfo to retrieve the status of various SiteLock scan products for a given site

  2. You maintain a list of SiteLock account IDs and site IDs.

    1. In this case, a call to getStatus is unnecessary, since you have a list of SiteLock site ID values associated with the account.

    2. scanInfo is called to retrieve the status of various SiteLock scan products for a given site.

  3. Call scanInfo by specifying only an account ID. This request will fetch complete scan information for all the sites that belong to an account ID. getStatus isn’t called in this case either.

An alternative to scanInfo is scanSummary. Unlike scanInfo which always returns information regarding the latest scan, scanSummary fetches summary information for a given site within the provided date range. Note that presently, scanSummary only returns data for the following scans: SMART File Scan, SMART Patch Scan, Risk Score, Platform Scan, and SMART Database Scan. Future updates will bring more scans under the purview of this call.

Both scanInfo and scanSummary provide a summary of scans. If you want to get the details, call scanDetail. Another useful method is getSMARTFileDiff which returns the detailed file changes since the last SMART File Scan.

Managing SSL Monitor

You can use the getSSLHost, addSSLHost, editSSLHost, and deleteSSLHost methods to manage the SSL Monitor behavior. Before starting an SSL Monitor, make sure to add the hostname for which to conduct an SSL check using addSSLHost.

Managing the SiteLock shield

To retrieve information regarding the shield that a user is entitled to display for their site (color, size, type, language), use the getShield method. If you need to modify the appearance of the shield, call modifyShield.

Triggering one or more scans

If you need to immediately run one or more scans for a site or an entire account, call scanNow.

Retrieving all system messages

SiteLock supports retrieving all system messages using the getTextReport method. These include messages that are generated by the scanners and the strings needed for the user interface. To retrieve a list of all languages supported by SiteLock, call getLanguageList.

Continuing to the SiteLock Dashboard

If the user wants to see more information than is available through the API, you can log them into SiteLock Dashboard using SSO authentication provided by the createToken method.