NAME

API::ParallelsWPB::Requests - processing of API requests

VERSION

version 0.03

METHODS

get_version($self)

Getting the current version of the Parallels Web Presence Builder instance on the defined server.

create_site($self, %param)

Creating a site.

%param:

state

trial | suspended | regular

This parameter is optional.
It specifies whether the site is in the trial mode, suspended or active (regular value). Sites in the trial mode can be edited, but cannot be published to a hosting account.

publicationSettings

{
    "targetUrl" => "ftp://username:password@ftp.example.com/path",
    "webSiteUrl" => "http://example.com",
    "fallbackIp" => "192.168.1.3"
}

This parameter is optional.

ownerInfo

{
    "personalName" => "John Doe",
    "companyName"  => "My Company LTD",
    "phone"        => "+1-954-555-555",
    "email"        => "john@example.com",
    "address"      => "New",
    "city"         => "New York",
    "state"        => "New York",
    "zip"          => "10292",
    "country"      => "United states"
}

This parameter is optional.

isPromoFooterVisible

1 | 0

This parameter is optional.
It specifies whether a text box containing an advertisement should be shown in a website footer (a section that appears at the bottom of every page on a site).
To learn more about how to set the content to be shown in the promotional footer,
see the section L<Configuring the Promotional Footer|http://download1.parallels.com/WPB/Doc/11.5/en-US/online/presence-builder-standalone-installation-administration-guide/71977.htm>.

Creating a Site

gen_token($self, %param)

Generating a Security Token for Accessing a Site

%param:

uuid

Site UUID. This parameter is mandatory.

localeCode

This parameter is optional.

It specifies the language that should be set for the user interface when the user (site owner) logs in to the editor.

The following languages are supported:

    en_US - American English.
    en_GB - British English.
    de_DE - German.
    es_ES - Spanish.
    fr_FR - French
    it_IT - Italian.
    ja_JP - Japanese.
    nl_NL - Dutch.
    pl_PL - Polish.
    pt_BR - Brazilian Portuguese
    ru_RU - Russian.
    zh_CN - simplified Chinese.
    zh_TW - traditional Chinese.

If no locale is defined, en_US will be used.

sessionLifeTime

This parameter is optional. It specifies the period of inactivity for a user's session in the editor. When this period elapses,
the security token expires and the user needs to log in again. 1800 seconds by default.

Generating a Security Token for Accessing a Site

deploy($self, %param)

Creates site based on a specified topic.

my $response =
  $client->deploy( localeCode => 'en_US', templateCode => 'music_blog' );

%param:

uuid

Site UUID. This parameter is mandatory.

localeCode

Locale code. The default value is en_US.

templateCode

Internal topic identification code. This parameter is optional. Default value is 'generic'.

title

Website name. This parameter is optional. Specifies what should be shown as the website name in the browser's title bar.

Creating a Site Based on a Website Topic

get_site_info($self, %param)

Retrieving information about a specific site.

%param:

uuid

Site UUID. This parameter is mandatory.

Retrieving Information About a Specific Site

get_sites_info($self)

Retrieving information about all sites.

No parameters are required.

Retrieving Information About All Sites

change_site_properties($self, %param)

Changes site properties.

%param:

state

trial | suspended | regular

This parameter is optional. It specifies whether the site is in trial mode, suspended or active (regular value). Sites in trial mode can be edited, but cannot be published to a hosting account.

publicationSettings

This parameter is optional. It specifies where to publish the site over FTP and what account credentials to use:

ownerInfo

This parameter is optional. It specifies the contact information of the site owner.

isPromoFooterVisible

1 | 0

This parameter is optional. It specifies whether a text box with an advertisement should be shown in the website footer.

Changing Site Properties and Settings

publish($self,%param)

Publish a site.

%param:

uuid

Site UUID.

Publishing a Website

delete_site($self, %param)

Deleting a site.

%param:

uuid

Site UUID.

Deleting a Site

get_promo_footer( $self )

Retrieving the current content of the promotional footer.

Retrieving the Current Content of the Promotional Footer

get_site_custom_variable($self, %param)

Retrieving a List of Custom Variables for a Website.

%param:

uuid

Site UUID.

Configuring the Trial Mode

Setting Trial Mode Messages

set_site_custom_variable($self, %param)

Setting a Custom Variable for a Website

%param:

uuid
variable1 => value1
variable2 => value2
...
variableN => valueN

Configuring the Trial Mode

Setting Trial Mode Messages

get_sites_custom_variables($self)

Retrieving Custom Variables Defined for All Websites

Configuring the Trial Mode

Setting Trial Mode Messages

set_sites_custom_variables($self, %param)

Setting Custom Variables for All Websites

%param:

variable1 => value1
variable2 => value2
...
variableN => valueN

Configuring the Trial Mode

Setting Trial Mode Messages

set_custom_trial_messages($self, @param)

Setting Custom Messages for the Trial Mode

my $response = $api->set_custom_trial_messages(
    {
        localeCode  => 'en_US',
        messages    => {
            defaultPersonalName => '{message1_en}',
            editorTopMessageTrialSite => '{message2_en}',
            initialMailSubject => '{message3_en}',
            initialMailHtml => '{message4_en}',
            trialSiteSignUpPublishTitle => '{message5_en}',
            trialSiteSignUpPublishMsg => '{message6_en}'
        }
    },
    {
        localeCode  => 'de_DE',
        messages    => {
            defaultPersonalName => '{message1_de}',
            editorTopMessageTrialSite => '{message2_de}',
            initialMailSubject => '{message3_de}',
            initialMailHtml => '{message4_de}',
            trialSiteSignUpPublishTitle => '{message5_de}',
            trialSiteSignUpPublishMsg => '{message6_de}'
        }
    },
);

get_custom_trial_messages($self)

Retrieving Custom Messages for the Trial Mode

change_promo_footer($self, %param)

Changing the Default Content of the Promotional Footer

%param:

message

set_site_promo_footer_visible($self, %param)

Showing the Promotional Footer on Websites

%param:

uuid

set_site_promo_footer_invisible($self, %param)

Removing the Promotional Footer from Websites

%param:

uuid

set_limits

Set limitations for single site

%param:

uuid

Site UUID.

The next list contains parameters/modules, that can be limited. Value for parameter must be an integer, that means maximum number of elements, that can be added on site. Value -1 means unlimited elements count for all modules/pages except eshop module. It can accept only positive numbers.

maxPagesNumber

Number of pages on a site.

video

Embedded Video module.

imagegallery

Image Gallery module.

blog

Blog module.

eshop

Online Store and Shopping Cart modules.

commenting

Commenting module.

contact

Contact Form module.

sharethis

Social Sharing module.

Advertisement module.

map

Map module.

Search module.

navigation

Navigation module.

breadcrumbs

Breadcrumbs module.

siteLogo

Site Logo module.

script

Script module.

slider

Image Slider module.

Restricting Resources by Means of the API

configure_buy_and_publish_dialog

Configuration for Buy & Publish dialog box in constructor.

$params:

[
    {
        "localeCode" => "de_DE",

        "messages" => {

            "upsellDialogTitle" => $title,
            "upsellDialogMsg"   => $html

        }
    },
    {
        "localeCode" => "ru_RU",

        "messages" => {

            "upsellDialogTitle" => $title,
            "upsellDialogMsg"   => $html

        }
    }
]

Configuring the Buy and Publish Dialog Window

NAME

API::ParallelsWPB::Requests

AUTHORS

Alexander Ruzhnikov <a.ruzhnikov@reg.ru>
Polina Shubina <shubina@reg.ru>

COPYRIGHT AND LICENSE

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

To install API::ParallelsWPB, copy and paste the appropriate command in to your terminal.

cpanm

cpanm API::ParallelsWPB

CPAN shell

perl -MCPAN -e shell
install API::ParallelsWPB

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

METHODS

get_version($self)

create_site($self, %param)

gen_token($self, %param)

deploy($self, %param)

get_site_info($self, %param)

get_sites_info($self)

change_site_properties($self, %param)

publish($self,%param)

delete_site($self, %param)

get_promo_footer( $self )

get_site_custom_variable($self, %param)

set_site_custom_variable($self, %param)

get_sites_custom_variables($self)

set_sites_custom_variables($self, %param)

set_custom_trial_messages($self, @param)

get_custom_trial_messages($self)

change_promo_footer($self, %param)

set_site_promo_footer_visible($self, %param)

set_site_promo_footer_invisible($self, %param)

set_limits

configure_buy_and_publish_dialog

NAME

SEE ALSO

AUTHORS

COPYRIGHT AND LICENSE

Module Install Instructions