API: OpenSRS

OpenSRS API Guide: Domains and SSL

Welcome to the OpenSRS API guide. Here you will find comprehensive documentation regarding our domain and SSL services. We hope this guide will help you start working with OpenSRS as quickly as possible. If you have any questions or concerns, please do not hesitate to contact help@opensrs.com

Get Started

update_product

Updates the SSL Service product and enables or disables the Symantec SSL Seal and/or the Symantec Search-in-Seal.

NOTE:

In order to enable the Symantec Search-in-Seal, SSL Seal must be enabled.

Request parameters for update_product

Standard parameters

  • action = update_product
  • object = trust_service attributes

Attributes

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

contact_email

Optional

The email address for the new SSL Service contact.

let_expire

Optional

Specifies whether renewal reminder email messages will be sent for the SSL Service product. This parameter may be used for any active SSL Service product.

Allowed values are:

  • 0—Send renewal reminder emails when the certificate is approaching its expiry date. This is the default.

  • 1—Do not send any renewal reminder emails.

product_id

Required

The ID number for the SSL Service.

seal_in_search

Optional

Specifies whether to enable the Symantec Seal-in-Search which displays the Symantec seal next to the link for your web site in online search results. Allowed values are:

  • 0—Do not enable the Symantec Seal-in- Search.

  • 1—Enable the Symantec Seal-in-Search

Important: If you submit this parameter, you must also submit the trust_seal parameter with the value equal to 1.

trust_seal

Optional

Specifies whether to enable the Symantec SSL Seal on your website. Allowed values are:

  • 0—Do not enable the Symantec SSL Seal.

  • 1—Enable the Symantec TrustSeal.

Response parameters for update_product

Standard parameters

  • action = reply
  • object = trust_service
  • is_success = a Boolean is returned, indicating success or failure of the request
  • response_code = response code indicating outcome of the request
  • response_text = message describing the outcome of the request

Attributes

If the request is successful, the attributes associative array may include the
following:

Parameter name
Obligation
Definition/Value

contact_email

Optional

The email address for the new SSL Service contact.

let_expire

Optional

Indicates whether renewal reminder email messages will be sent for the SSL Service product.

Allowed values are:

  • 0—Send renewal reminder emails when the certificate is approaching its expiry date. This is the default.

  • 1—Do not send any renewal reminder emails.

product_id

Returned if
is_success = true

The ID number for the SSL Service.

seal_in_search

Optional

The status of the Symantec Seal-in-Search. Allowed values are:

  • 0—Not enabled.

  • 1—Enabled.

trust_seal

Optional

The status of the Symantec SSL Seal. Allowed values are:

  • 0—Not enabled.
  • 1—Enabled.

Examples for update_product

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">update_product</item>
                <item key="object">trust_service</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="trust_seal">1</item>
                        <item key="contact_email">newqafive@example.com</item>
                        <item key="seal_in_search">1</item>
                        <item key="let_expire">1</item>
                        <item key="product_id">279</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">TRUST_SERVICE</item>
                <item key="is_success">1</item>
                <item key="response_text">Command completed successfully.</item>
                <item key="response_code">200</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="trust_seal">1</item>
                        <item key="product_id">279</item>
                        <item key="contact_email">newqafive@example.com</item>
                        <item key="let_expire">1</item>
                        <item key="seal_in_search">1</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

update_product

Updates the SSL Service product and enables or disables the Symantec SSL Seal and/or the Symantec Search-in-Seal.