ePages 6.15.1 - DE_EPAGES/FlexProvider/API/WebService/FlexProviderService.pm

Package DE_EPAGES::FlexProvider::API::WebService::FlexProviderService

Provides web service access to configure virtual flex machine, create shop, update machine config etc.

Example
use DE_EPAGES::WebService::API::Client;
my $FPService = DE_EPAGES::WebService::API::Client
    ->uri('urn://epages.de/WebService/FlexProviderService/2010/07')
    ->proxy("http://localhost:80/epages/Site.soap")
    ->userinfo( "/Users/$Login:$Password" );
print Dumper $FPService->getInfoVM({'VMIpAddress'=>'172.20.128.242'});

Functions

configureVM
createVMshop
getInfoVM
updateVM

configureVM

configure VM

Syntax
$configured = $FlexProviderService->configureVM($hHWParams,$hCTParams)->result;
$ret = $FlexProviderService->getInfoVM(
    {'VMIpAddress'=>'172.20.128.242'},
    {'StoreDomainName'=>'CentOS242.intern.epages.de'});
Input
$hHWParams (ref.hash.string)
hardware parameter
  • VMIpAddress - VM ip adress - string
$hCTParams (ref.hash)
Container parameters
  • VMEpagesWebServicePassword (optional) - the WebService password for the Store - string
  • VMType (optional) - Type for new Container - string
  • StoreDomainName (optional) - DomainName for the Store (not the Shop) default: IP address - string
Return
$configured (bool)
flag about success of configure call

createVMshop

Establish webservice connection to the specified virtual machine If epages is running on the virtual machine, the cartidges are syncronized with the site database and a shop with the given params was created

Syntax
$updated = $FlexProviderService->createVMshop($hHWParams,$hShopParam)->result;
$ret = $FlexProviderService->createVMshop(
    {'VMIpAddress'=>'172.20.128.242'},
    {   ShopType => 'Demo',
        Alias => 'TestShop_172.20.8.1',
        ShopAlias => 'TestShop',
        DomainName => 'mystorefrontdomain.co.uk',
        IsTrialShop => 1,
    }
);
Input
$hHWParams (ref.hash)
virtual machine parameters
  • VMIpAddress - VM ip adress - string
$hShopParams (ref.hash)
Shop parameters
  • ShopType (optional) - shoptype alias - string
  • Alias (optional) - uniques shop alias for the provider - string
  • ShopAlias - shop alias in store database - string
  • DomainName (optional) - vainty domain name ot the shop - string
  • HasSSLCertificate (optional) - the domain specified by -domainname is SSL-enabled - boolean
  • WebServerScriptNamePart (optional) - web server script name part - string
  • IsTrialShop (optional) - the shop is in trial period - boolean
  • IsInternalTestShop (optional) - the shop is used for test or support purposes - boolean
  • IsClosed (optional) - created shop is closed - boolean
  • ImportFiles (optional) - files to import - string
  • PublicFilesDir (optional) - directory with public files, e.g. images - string
  • MerchantLogin (optional) - merchant login - string
  • MerchantPassword (optional) - merchant password - string
  • MerchantEMail (optional) - merchant email address - string
Return
$created (bool)
flag about success of shop creation

getInfoVM

Returns information about a virtual flex machine and configured shop

Syntax
$hInfo = $FlexProviderService->getInfoVM($hHWParams)->result;
$ret = $FlexProviderService->getInfoVM({'VMIpAddress'=>'172.20.128.242'});
Input
$hHWParams (ref.hash.string)
hardware parameter
  • VMIpAddress - VM ip adress - string
Return
$hEpagesInfo (ref.hash)
epages info parameters
  • ResponseCode - response code from configuration server 0 | 1 if error - int
  • Dedicated - DEDICATED entry from Webinterface.conf - string
  • SytemDomainName - domain name of the system - string
  • MaxMemory - MAXMEMORY entry from WebInterface.conf - int
  • AppserverCount - Count of configured application servers - int
  • ApserverCountRunning - Count of running application servers - int
  • AppserverString - APPLICATIONSERVER entry of Webinterface.conf - string
  • ipaddress - IP section of Webinterface.conf - string
  • InstalledEpagesVersion - the installed ePages version - string

updateVM

update an running epages in a virtual machine to the specified VMType

Syntax
$updated = $FlexProviderService->updateVM($hHWParams,$VMType)->result;
$ret = $FlexProviderService->updateVM(
    {'VMIpAddress'=>'172.20.128.242'},
    'MerchantProPlus');
Input
$hHWParams (ref.hash)
vm parameters
  • VMIpAddress - VM ip adress - string
$EpagesVMType (string)
the vm type to apply on the virtual machine
Return
$updated (bool)
flag about success of update