Using the SiteLock API

The API endpoint is:

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

For security reasons, 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 are provided by SiteLock upon the establishment of a partner account.

The XML doctype element is sent at the start of the XML request or response:

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>

The presence of this is assumed and won’t be displayed throughout this document.

Best practices for coding XML

XML uses predefined entity references to represent characters that are markup—​sensitive in certain contexts. These entity references prevent browsers from misinterpreting these characters.

For example, the less than < and greater than > symbols are used to open and close element tags in the XML data. Using the entity names &lt; and &gt; in place of < and > prevents the XML processor from interpreting these characters as element delimiters and avoids potential XML processing errors.

There are 5 predefined entity references in XML.

Entity Reference Character Description

&lt;

<

Less than

&gt;

>

Greater than

&amp;

&

Ampersand

&apos;

'`

Apostrophe

&quot;

"`

Quotation mark

Only the characters < and & are strictly illegal in XML. The > character is legal, but the SiteLock API requires that you replace the above characters with their entity references.

Best practices for representing state and country data

When including the state and country data of a SiteLock user, use the appropriate ISO 3166 code as defined by the following standards:

HTTP response message

After posting an XML payload to the SiteLock API, you should check the HTTP status of the response.

A 200 OK response indicates that the XML was valid and the request has been returned.

A 500 Internal Server Error response indicates that there was a problem with the operation. You should check the error message to determine the problem and potentially make changes to your SiteLock API code.