JeraSoft Documentation Portal
Docs for all releases
This article represents a quick overview of standard options available while using the Client Portal. Explore this article to get more about the user interface, functions and deployment configurations.
The Client Portal is a separate application integrated with the VCS via API. It has a user friendly interface and it's tailored for your clients to manage services they purchased. For example, they can check their rates, refill balance, update contact and billing details, check a detailed call history with all related statistics and cost.
It has been designed to be as simple and easy to understand as possible and should cut a lot of basic customers' questions.
Starting from the VCS 3.13, the Client Portal will be hosted by default on port 9080. To access it, open http://VCS-IP-ADDRESS:9080/. Moreover, you could assign your own domain name to the portal.
Fully API based
The system is fully based on API integration. Therefore, it does not require any direct access to the VCS database and provides more secure approach.
Can be hosted separately
You can move the Clients Portal to other server and just configure VCS IP address in the API settings. As result you can fully isolate VCS from the public internet.
Full Open Sourced
The portal comes with all source code. It allows you to either customize the system or extend it or just use as a reference guide for development of your own portal.
There are 4 main section in the Client Portal – overview, billing & payments, usage history and account sections. Let's view them in more details below.
Screenshot: Client Portal settings/main components
There are few steps to be performed before the Client Portal can be used:
In order to tune Client Portal configuration you have to:
Below we provide description of all settings you can find in the file. You can also find sample configuration with all available settings at:
URL for the Core API JSON-RPC service
CoreAPI Auth Token (could be found in the Users section → "CoreAPI Token" field)
URL for the Management API
Login of the user under which all request will be performed (should be same user for which you use CoreAPI Auth Token)
|managementApi.passsword||Password of the user under which all request will be performed|
Admin Panel web-address
PayPal Client ID
PayPal Client Secret Key
Authorize.Net API Login ID
Authorize.Net API Transaction Key
|authorizenet.apiSignatureKey||Authorize.Net API Signature Key|
Client Portal works on ports 9080 and 9090. Make sure you open them on your firewall in order for portal to work correctly.
Access to the panel for your customers is configured in a respective customer's properties in the VCS web-interface: Clients section → Client Info tab → Client's Panel sub-section. Make sure, you have enabled the access and specified login and password. The "Access" field is deprecated and will be removed in further versions.
Screenshot: Clients section/Client Info tab
As mentioned above, JeraSoft Client Portal is offered as an open source software, so you can look into it, learn form it, and adapt it to your needs. You can use it as is, make it a starting point for your own development or use as a reference guide to build an own solution.
Client Portal Support
Please note, that JeraSoft team is responsible for providing support only for original Client Portal functionality with an initial unchanged source code.
To add your own domain name for the Client Portal, you have to do the following:
You may personalize your panel to make it better fit to your company look and feel. You can start with logo and if you are familiar with CSS, you may add CSS styles. Below you can find locations for the respective files. Please note that given paths are relative to /usr/local/vcs/www/portal/frontend/dist/assets.
As mentioned above, Client Portal comes with all source code and you can use it as a reference guide or a starting point for your own development. Feel free to modify the code, improve it or extend, build it into some other platforms. For example, you can update the menu, a panel view, edit a set of filters, modify grouping options or create your own panel by taking it as example a functional implementation.
The technologies used for the development of the Clients Portal are: