Direct API

You can place orders through the SiteLock Online Provisioning API which allows the end-customer to configure the products. This is a very simple technical integration, especially for existing Sectigo resellers.

For security, the SiteLock Online Provisioning API requires that all transactions be submitted via the POST method using the HTTPS protocol. All API transactions require the use of a user ID and password, which will be provided by SiteLock upon the establishment of a partner account.

The following features are available through the API:

  • Placing orders through the SiteLock Provisioning API

    • SiteLock Online Provisioning API is based on XML structure

  • API Documentation contains syntax and examples for all the supported features provided using XML structure for easy integration:

    • Provisioning new accounts

    • Modifying/upgrading existing accounts

    • Deleting accounts

    • Using single sign-on authentication

    • Retrieving a list of accounts

    • Retrieving account statuses

    • Retrieving pending emails and marking emails as sent

    • Changing or resetting user passwords

    • Dashboard integration

    • SMART configuration

    • SMART Patch configuration

    • SMART Database configuration

    • Backup

    • Provisioning add-on products

    • Managing the TrueShield product

    • Using the Free Scan API

    • SiteLock IP addresses

Typical partner profile

  • Service providers selling SiteLock as an upsell item with hosting plans

  • Service providers rolling SiteLock into their existing offering as a value add/differentiator

Business objective

Offering security solutions on a per-site license that produces revenue.

Integration timeline

Once a contract has been agreed upon, the integration process begins. Initially, a weekly cadence meeting is preferable to establish what is needed by the partner and what blockers exist.

  • SiteLock via API: 60-120 days is typical when prioritized.

Expertise needed

  • SiteLock API: Developers with an understanding of XML/SOAP API

Prerequisites

  • Contract in place: Prior to integration, a contract should be in place that establishes which plans will be offered, their respective buy and sell rates, and any other commitments.

  • Partner account setup: Each partner will need their own reseller account in the SiteLock system. During the creation of the partner account, the partner’s plans will be created, and pricing recorded.

  • API access setup: The SiteLock Partner API uses a private endpoint that permits access only to approved IPs. Submit the list of IPs to be whitelisted for communicating with the API endpoint to SiteLock Engineering via [email protected]. The total number of IP addresses should be small, typically less than five (5) addresses. In some scenarios, such as when the partner is using the SiteLock WHM/cPanel plugin, a large number of unique machines may need to interact with our API for routine activities such as generating SSO tokens. In these cases, we recommend routing API requests via a local proxy on the partner side. The local proxy should enforce security measures such as an approved IP table, parsing requests prior to relay, and other authentication methods where possible.

Exclusions/Inclusions

The SiteLock Partner API has been built to facilitate a wide variety of functions and abilities, with highly customizable approaches available through custom middleware development by the partner. Extensive data points are available via direct API integration that can be used to build communications campaigns (for example, educational, marketing, and sales campaigns), conduct statistical research, provide account management outside of the SiteLock Customer Dashboard, and deliver products through an OEM ("white label") experience — among many other possible uses. See the SiteLock Partner API documentation for more information.

Documentation

The following documents are available for integration through API.

Document name

Document type

SiteLock Partner API Documentation

This document introduces the partners to SiteLock Online Provisioning API and explains how to plan for a smooth implementation phase.

SiteLock Partner Quick Start Guide

This document is for partners to integrate SiteLock’s most common use cases.

SiteLock API Presentation Slides

These slides provide details on the different stages of the API integration process and API best practices.