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

cancel_free_trial

Cancel a SSL Service 30 day free trial order.
Free trials are available for the following SSL Service products:

  • GeoTrust—True BusinessID with EV
  • Symantec—SecureSite, Secure Site Pro, Secure Site with EV, and Secure
    Site Pro with EVc

Good to Know:

You can cancel the free trial at any time during the 30 day free trial period
without incurring a charge. If the product is not cancelled by the end of the
30 day period, the product is immediately activated, and the customer is
charged for the term that they selected when they placed the order. The
expiry date is calculated from the date that the paid term begins, not the
date that the free trial began.

GeoTrust and Symantec require customer approval for cancellation.
The supplier sends the customer an email asking them to approve the cancellation.
Once the cancellation is approved, the status of the order changes to Revoked/Declined.

Note:

When you cancel a free trial, you will not be able to order another
SSL Service order for that domain until the full 30 days of the free trial
period have passed.

Request parameters for cancel_free_trial

Standard parameters

  • action = cancel_order
  • object = trust_service

Attributes

Parameters within the attributes associative array are described below.

Note: You must specify at least one of these parameters.

Parameter name
Obligation
Definition/Value

order_id

Optional

The SSL Service order ID number.

product_id

Optional

The SSL Service product ID number.

Response parameters for cancel_free_trial

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

domain

Returned if
is_success = true

The domain with which the SSL Service
order is associated.

product_id

Returned if is_success = true

The SSL Service product ID number.

state

Returned if is_success = true

The state of the order. Allowed values are:

  • approver-confirmed—Owner has confirmed the domain vetted
    certificate.

  • awaiting-approval—Order processed successfully; waiting for supplier approval.

  • cancelled—Pending order was cancelled.

  • completed—Order is complete.

  • declined—Order cancelled after it was
    processed or declined by the supplier.

  • in-progress—Order is in progress.

  • pending—Order saved as pending.

Examples for cancel_free_trial

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">cancel_free_trial</item>
                <item key="object">trust_service</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="order_id">7712</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="response_text">Command completed successfully.</item>
                <item key="response_code">200</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">1320701286testing.com</item>
                        <item key="product_id">1848</item>
                        <item key="state">revoked</item>
                    </dt_assoc>
                </item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

cancel_free_trial

Cancel a SSL Service 30 day free trial order.
Free trials are available for the following SSL Service products:

  • GeoTrust—True BusinessID with EV
  • Symantec—SecureSite, Secure Site Pro, Secure Site with EV, and Secure
    Site Pro with EVc