ePages 6.10 - DE_EPAGES/ShopConfiguration/API/WebService/SimpleProvisioningService.pm

Package DE_EPAGES::ShopConfiguration::API::WebService::SimpleProvisioningService

Provides simpliefied web service access to create and update shops

Example
use DE_EPAGES::WebService::API::Client;
my $SimpleProvisioningService = DE_EPAGES::WebService::API::Client
    ->uri('urn://epages.de/WebService/SimpleProvisioningService/2009/10')
    ->proxy("http://localhost:80/epages/Site.soap");
$SimpleProvisioningService->userinfo( "/Providers/$ProviderAlias/Users/$Login:$Password" );
$SimpleProvisioningService->create({
    Alias => 'DemoShop2',
    ShopType => 'ECom100',
});

Functions

create
exists
getInfo
markForDeletion
rename
update

create

Creates a new shop on behalf of the current provider. Sets login, email and password for the primary administrator.

Syntax
$SimpleProvisioningService->create({
    Alias => $Alias,
    ShopType => $ShopType,
    IsClosed => $IsClosed,
    IsTrialShop => $IsTrialShop,
    IsInternalTestShop => $IsInternalTestShop,
    DomainName  => $DomainName,
    HasSSLCertificate => $HasSSLCertificate,
    MerchantLogin => $MerchantLogin,
    MerchantPassword => $MerchantPassword,
    MerchantEMail => $MerchantEMail,
})->result;
Example
my $ShopID = $SimpleProvisioningService->create({
    Alias => 'DemoShop',
    ShopType => 'ECom100',
    MerchantLogin => 'smith',
    MerchantPassword => 'geheim',
    MerchantEMail => 'asmith@hotmail.com',
})->result;
Input
$Alias (string)
unique shop identifier
$ShopType (string)
shop type alias
$IsClosed (boolean)
true if the new shop is closed by provider (optional, default: 0)
$IsTrialShop (boolean)
true if the shop is in trial period (optional, default: 0)
$IsInternalTestShop (boolean)
true if the shop is used for test or support purposes (optional, default: 0)
$DomainName (string)
domain name to access the shop (optional)
$HasSSLCertificate (string)
true if the web server has an SSL certificate for the shop (optional)
$MerchantLogin (string)
merchant login (optional)
$MerchantPassword (string)
merchant password (optional)
$MerchantEMail (string)
merchant email address (optional)

exists

Returns true if the provider has a shop with the given alias name.

Syntax
$Exists = $SimpleProvisioningService->exists({
    Alias => $Alias
})->result;
Example
print "hurray" if $SimpleProvisioningService->exists({
    Alias => 'DemoShop'
})->result;
Input
$Alias (string)
unique shop identifier

getInfo

Returns information about a shop.

Syntax
$hShopInfo = $ShopConfigService->getInfo({
    Alias => $Alias
})->result;
Input
$Alias (string)
unique shop identifier
Return
$hShopInfo (ref.hash)
shop data
  • Alias - unique shop name for the provider - string
  • ShopType - shop type alias - string
  • Database - store database identifier - string
  • IsClosed - true if closed by provider - boolean
  • IsDeleted - true if deleted in store database - boolean
  • IsTrialShop - true if the shop is in trial period - boolean
  • IsInternalTestShop - true if the shop is used for test or support purpose - boolean
  • DomainName - shop domain name - string
  • HasSSLCertificate - true if the web server has an SSL certificate for the shop - string
  • MerchantLogin - merchant login - string
  • MerchantEMail - merchant email address - string
  • LastMerchantLoginDate - date and time of the last login in the back-offices - DateTime
  • IsMarkedForDel - true if the shop os marked for deletion - boolean

markForDeletion

Schedules a shop for deletion.

Syntax
$SimpleProvisioningService->markForDeletion({
    Alias => $Alias
});
Example
$SimpleProvisioningService->markForDeletion({
    Alias => 'DemoShop'
});
Input
$Alias (string)
unique shop identifier

rename

Changes the alias of a shop.

Syntax
$SimpleProvisioningService->rename({
    Alias => $Alias,
    NewAlias => $NewAlias,
});
Example
$SimpleProvisioningService->rename({
    Alias => 'DemoShop',
    NewAlias => 'MyShop',
});
Input
$Alias (string)
previous alias
$NewAlias (string)
new alias

update

Updates a shop. Sets login, email and password for the primary administrator. See DE_EPAGES::ShopConfiguration::API::WebService::ShopConfigService::update

Syntax
$SimpleProvisioningService->update({
    Alias => $Alias,
    ShopType => $ShopType,
    IsClosed => $IsClosed,
    IsTrialShop => $IsTrialShop,
    IsInternalTestShop => $IsInternalTestShop,
    DomainName => $DomainName,
    HasSSLCertificate => $HasSSLCertificate,
    MerchantLogin => $MerchantLogin,
    MerchantPassword => $MerchantPassword,
    MerchantEMail => $MerchantEMail,
});
Input
$Alias (string)
unique shop identifier
$IsClosed (boolean)
true if the shop is closed by provider (optional)
$IsTrialShop (boolean)
true if the shop is in trial period (optional)
$IsInternalTestShop (boolean)
true if the shop is used for test or support purposes (optional)
$DomainName (string)
domain name to access the shop (optional)
$HasSSLCertificate (string)
true if the web server has an SSL certificate for the shop (optional)
$MerchantLogin (string)
merchant login (optional)
$MerchantPassword (string)
merchant password (optional)
$MerchantEMail (string)
merchant email address (optional)