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

create (publishing)

Creates a new goMobi domain.

Request parameters for create (publishing)

Standard parameters

  • action = create
  • object = publishing

Attributes

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

domain

Required

The name of the mobile domain that you want to create.

end_user_auth_info

Optional

A list of the end user account information.

For more information, see the End user auth info table below.

service_type

Required

The type of Publishing service.

Allowed value is gomobi.

source_domain

Optional

The name of the domain on which the new mobile web page will be based.

End user auth info

Parameters within the end_user_auth_info associative array are described
below.

If you are adding the service to an existing account, you only need to specify the username; if you are creating a new account, you must specify username, email_address,and password.

Note:

If you do not specify a username and password, the service will work; however, the domain owner will not be able to access the end user control panel at domainadmin.com. In that case, you can either provision the domain for your customer or you can provide your own end user interface.

Parameter name
Obligation
Definition/Value

email_address

Required if end_user_auth_info is specified and this is a new account

The domain owner's email address.

password

Required if end_user_auth_info is specified and this is a new account

The password associated with the Publishing service. The password must be at least 8 characters long.

username

Required if end_user_auth_info is specified

The username associated with the Publishing service. The username must be at least 6 characters long.

Response parameters for create (publishing)

Standard parameters

  • action = reply
  • object = publishing
  • 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

Examples for create (publishing)

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">CREATE</item>
                <item key="object">PUBLISHING</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="service_type">gomobi</item>
                        <item key="domain">example.net</item>
                        <item key="source_domain">example.com</item>
                        <item key="end_user_auth_info">
                            <dt_assoc>
                                <item key="email_address">danny@example.com</item>
                                <item key="password">BigPWTest</item>
                                <item key="username">danny1234</item>
                            </dt_assoc>
                        </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">PUBLISHING</item>
                <item key="response_text">Publishing service created</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

create (publishing)

Creates a new goMobi domain.