Shop-window

From ISPWiki
Jump to: navigation, search

Introduction

A Shop-window is the way how services from BILLmanager are displayed on a provider's web-site. Starting from 5.47 BILLmanager delivers advanced configuration options.

This feature allows non-authorized users to make orders in your billing system. A client could see products and services only available for order only at his provider's web-site or after loginning to BILLmanager (a provider had to keep his tariff plans and prices up-to-date). Now the shop-window enables potential clients to view and order provider's services without registration.

Moreover, BILLmanager has a standard site template allowing hosting providers who don't have their own web-site to get an automatically generated site. The template includes standard modules and functions (modules - "About company", "Services", etc., functions - registration, login to Client area, etc.). Information on your site, including your company's information, will be generated based on tariff plans created in BILLmanager. Thus, your web-site will always have up-to-date information about your company and services.

Providers who already have a web-site, can integrate it with the shop-window. This will allow to automatically update the information about services and prices.

Configuration

Navigate to the Global settings module -- Shop-window settings.

  • Disable shop-window - the shop-window will be hidden.
  • Login form - the shop-window is activated - you can set up integration with your website or provide a direct link to the shop-window.
  • Open panel - entering the BILLmanager URL in the browser will open the Shop-window rather than the login form.
  • Shop window site - entering the BILLmanager URL in the browser will open the automatically generated site.

Shop-window

The shop-window allows an unauthorized user to view services offered by his service provider.

Vitrina2-en.png

With the shop-window you can order services - after you have placed a new order into the Cart, BILLmanager will ask you to log in and pay for your order.

Vitrina3-en.png

Shop-window site

If you choose Shop-window site, when entering BILLmanager URL into the browser window, an automatically generated site will open.

The site is updates and modified when you edit Company, Provider, Tariff plan, Brand settings.

Source data for the site is located in the /usr/local/mgr5/etc/showroom directory. You can modify it according to your needs.

The site is located in the /usr/local/mgr5/skins/showroom/1/ directory, where 1 - provider's Id. The site can be accessed by following BILLmanager URL.

Be sure to provide correct Site URL and Billing URL in the Provider's configuration form.

The showroom function generates the site, and updates sites for all providers. Execute the following command to call the function:

/usr/local/mgr5/sbin/mgrctl -m billmgr showroom

In order to reset the changes in the directory with site templates, delete the /usr/local/mgr5/etc/showroom directory. Then the site will be created with default templates located in /usr/local/mgr5/etc/showroom.sample


The shop-window site is created only in Russian. However, you can translate it to a desired language when needed.

Integration with existing site

To add a shop-window, place the following script on the page where you want your shop-window to display:

<script src="BILLMGR_HOST/manimg/orion/billmgrStore.init.js"></script>
 
<script type="text/javascript">
  billmgrStore.init({
    host: BILLMGR_HOST,
    startform: STARTFORM
  });
</script>

Where:

BILLMGR_HOST - the billing hostname. Eg. 'https://my.ispsystem.com'

STARTFORM - parameters of the Shop-window form. E.g. 'func=showroom.redirect&redirect_to=service.order.itemtype' (it cannot have values startform: 'func=register.logon', i.e. you don't need to specify a registration function).

Note!

Configure allow_origin for ihttpd, if you want your shop-window to run on a domain, which differs from the billing panel's domain. Add the following information into the ihttpd configuration file

allow_origin <site's domain name>

Example:

listen {
	ip 172.32.12.23
	allow_origin http://showroom.com
	redirect
}

where http://showroom.com - is your site with shop window.



Parameters

Property Default value Description
basket false Show the Cart with services. Possible values {blockId: BLOCK_TAGRET_ID}, where BLOCK_TAGRET_ID - name of the id of html element, where the cart should be displayed; false - do not show the Cart.
usermenu false Show user menu. Possible values {blockId: BLOCK_TAGRET_ID}, where BLOCK_TAGRET_ID - name of the id of html element, where the menu should be displayed; false - do not show the menu.
title false Show the form heading. Possible values true - show the heading, false - do not show
wizard_step false Show order steps. Possible values true - show steps, false - do not show
custom_css false Enable the css file. Possible values - an empty string containing a path to the css file, e.g.- 'https://my.ispsystem.com/manimg/orion/default/custom.css'

Example

<!DOCTYPE html>
<html>
  <head>
    <title>My Store</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
  </head>
  <body>
    <ul>
      <li id="basket"></li>
      <li id="usermenu"></li>
    </ul>
    <h1>Wellcom, to my store!</h1>
    <div>
      <script src="https://my.ispsystem.com/manimg/orion/billmgrStore.init.js"></script>
      <script type="text/javascript">
        billmgrStore.init({
          host: 'https://my.ispsystem.com',
          startform:  startform: 'func=showroom.redirect&redirect_to=service.order.itemtype',
          basket: { blockId: 'basket' },
          usermenu: { blockId:  'usermenu' },
          title: true,
          wizard_step: true,
          custom_css: 'https://my.ispsystem.com/manimg/orion/default/custom.css'
        });
      </script>
    </div>
  </body>
</html>


See also Integration between BILLmanager and website