provisionAddon — Provisioning SiteLock Backup & Recovery

SiteLock Backup provides backup services in two areas: Backup Files and Backup Database. Backup can be provisioned as an add-on to an existing package or by itself. See Provisioning an add-on as a standalone product if you intend to provision this for a user who doesn’t have an existing SiteLock scanning package.

When provisioning this add-on, you may want to purchase more than one subscription. For example, when you need to provide a backup for two or more sites. All Backup subscriptions can be provisioned in one request and can be attached to the same SiteLock account_id.

The API endpoint is:

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

Request format

The example request contains three instances of the addonInfo element, one for each subscription purchased. The following explanation documents one request.

SiteLockOnlineRequest: This element is used to delineate the full API request.
- authentication: The partner’s username, password, and branding
  - username: The partner’s API username
  - password: The partner’s API password
  - partner: (Optional) The brand name to use in messaging
- provisionAddon: The method name
  - addonInfo: (Repeatable) The subscription to provision
    
    site_id: A valid SiteLock site ID. See also Provisioning an add-on as a standalone product
    
    subscription: A partner-specific plan ID that identifies this add-on
    
    amount: (Optional) The decimal amount the user was billed for this add-on
    
    This element is not optional when partner invoicing is based on a revenue sharing agreement.
    
    renewal_date: (Optional) A date to be used for renewal

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <provisionAddon>
        <addonInfo>
            <site_id>442676</site_id>
            <amount>129.95</amount>
            <subscription>XXX</subscription>
        </addonInfo>
        <addonInfo>
            <site_id>379430</site_id>
            <subscription>XXX</subscription>
            <renewal_date>2015-01-01</renewal_date>
        </addonInfo>
        <addonInfo>
            <site_id>15905</site_id>
            <subscription>XXX</subscription>
        </addonInfo>
    </provisionAddon>
</SiteLockOnlineRequest>

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- provisionAddon: The method name
  - addonStatuses: A list of subscriptions that were provisioned.
    
    addonStatus: (Repeatable) This element corresponds to the addonInfo element in the request
    
    account_id: The SiteLock account ID to which belongs the site
    
    site_id: The SiteLock site ID from the provisionAddon request
    
    subscription: The plan ID provided in the subscription field from the provisionAddon request.
    
    subscription_id: A unique value used to identify the instance of the service. This can be used in requests to deleteAddon.
    
    status: The value can be one of the following:
    
    ok: Success return value
    
    error: Error return value. The message element contains more detail.
    
    code: (optional) This element is present only when the value of status is error. To view a list of possible error codes, see Error codes
    
    message: The detailed error or success message
    
    mid: This element is blank. It’s retained for compatibility purposes only.

Since multiple provisioning requests can be submitted at one time, the status of an individual provisioning request should be determined by reading the status and message fields of the specific addonStatus element. To find the addonStatus element in question, use the site ID and subscription plan ID submitted in the provisionAddon request. In the following example, the first two requests to provision this add-on succeeded, whereas the third one failed because the site specified was invalid for this partner.

Example response

<SiteLockOnlineResponse>
    <provisionAddon>
        <addonStatuses>
            <addonStatus>
                <account_id>442676</account_id>
                <site_id>1000297</site_id>
                <subscription>631</subscription>
                <subscription_id>1234</subscription_id>
                <status>ok</status>
                <message>Backup Subscription added ok</message>
                <mid></mid>
            </addonStatus>
            <addonStatus>
                <account_id>442676</account_id>
                <site_id>379430</site_id>
                <subscription>632</subscription>
                <subscription_id>1254</subscription_id>
                <status>ok</status>
                <message>Backup Subscription added ok</message>
                <mid></mid>
            </addonStatus>
            <addonStatus>
                <account_id></account_id>
                <site_id>15905</site_id>
                <subscription>632</subscription>
                <status>error</status>
                <code>ISI</code>
                <message>Invalid/Unknown Site ID</message>
                <mid> </mid>
            </addonStatus>
        </addonStatuses>
    </provisionAddon>
</SiteLockOnlineResponse>