WebServius Consumer Portal White Labeling

The entire consumer web UI experience can be white-labeled to give the provider full control over branding and much of the presentation. The following elements can be customized:

Web page presentation, through the use of an <iframe>
Text of automated email notifications and return address
Address of API endpoint

Other customization will be considered on a case-by-case basis.

Hosting the portal in an <iframe>

You can host the consumer portal in any page that allows enough horizontal space for the fixed-width iframe (960 px).

Insert the following just before the closing </head> tag:

<script type="text/javascript" src="http://www.webservius.com/js/easyXDM.min.js"></script>

Insert the following where the iframe should appear on the page (the iframe will be inserted by the script):
```
<div id="wsFrame"></div>
```
The following function initializes the frame:
```
loadFrame('WebServius URL');
```

Use the ONLOAD attribute in the <body> tag with the above function. Example:

<body onload="loadFrame('cons/subscribe.aspx?p=acme&s=acmeapi&cobrand=acme&resize=1')">

If you would like to use your own menu to navigate to different WebServius pages within the frame, use the setFrame function along with the WebServius URL. Example menu link:
```
<a href="javascript:setFrame('cons?cobrand=acme&resize=1')">Manage subscription</a>
```
You can style the iframe using #wsFrame iframe {} in a CSS stylesheet or within a <style> tag. At the minimum include the following to set the correct iframe width:
```
<style type="text/css">#wsFrame iframe {width:960px; overflow-x:hidden;}</style>
```

Typical URLs to use

White-label mode is invoked by adding the cobrand=ShortName&resize=1 URL parameters to any consumer portal page. ShortName is your provider short name, which can be viewed or modified on the My Account tab of the provider portal. URLs should be relative to https://www.webservius.com/.

For new subscriptions to a particular API:

cons/subscribe.aspx?p=ShortName&s=ServiceShortName&cobrand=ShortName&resize=1

For new subscriptions (list of APIs) – coming soon:

cons/subscribe.aspx?p=ShortName&cobrand=ShortName&resize=1

Consumer portal (for existing API users):

cons?cobrand=ShortName&resize=1

If in doubt, use option #1 above. Existing users will be given the option to sign in. Do not use URLs in the format of services/ShortName/ServiceShortName for white labeling.

Sample page:

<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <title>ACME Data Provider</title>
        <script type="text/javascript" src="http://www.webservius.com/js/easyXDM.min.js"></script>
        <style type="text/css">#wsFrame iframe {width:960px; height:800px; overflow-x:hidden;}</style>
    </head>
    <body onload="loadFrame('cons/subscribe.aspx?p=acme&s=acmeapi&cobrand=acme&resize=1')">
        ...
        <div id="wsFrame"></div>
        ...
    </body>
</html>

Automatic iframe resizing

The resize=1 parameter enables the iframe to automatically resize vertically to fit the page content, avoiding the need for vertical scroll bars within the iframe for a more integrated look. If you prefer a fixed vertical height with inner scroll bars, omit this parameter from the WebServius URLs and add the desired height to the iframe CSS style (e.g. "height: 800px;").

Customizing email text

Please contact support@webservius.com for the current default text for your reference. The following events generate emails, which can be customized:

New API user signed up in a self-service fashion
Email verification email for an API user
Password reset email
Subscription manually deactivated from provider portal
New API user manually created from provider portal
New subscription manually created from provider portal

Customizing API endpoint address

By default, your service endpoint looks similar to http://svc.webservius.com/v1/{providerShortName}/{serviceShortName}. If you would like to use your own domain name, e.g. http://api.example.com/MyService:

Create a CNAME DNS record pointing from your domain (e.g. api.example.com) to svc.webservius.com

After the DNS change has been fully set up and propagated, set up your desired endpoint address in the “Service Settings” screen on the WebServius Provider Portal