This projects contains a sample premium app and an automated on-boarding flow for setting up the app in the PureCloud organization.
https://developer.mypurecloud.com/appfoundry/premium-client-applications.html
TL;DR: Premium Client Applications are a type of Custom Client Applications that streamline and automate monetization through PureCloud.
The Premium App sample is hosted in GH-Pages: https://mypurecloud.github.io/purecloud-premium-app/
The wizard or provisioning tool is located at: https://mypurecloud.github.io/purecloud-premium-app/wizard/
- A working PureCloud Org with the 'premium-app-example' integration enabled.
- An admin user that will run the wizard and access the premium app.
The entire web app is hosted in Github pages with the root directory being the docs folder.
There are two folders inside /docs.
- premium-app-sample
- Contains the sample Premium App.
- wizard
- Contains the provisioning tool for the Premium App. This is the tool that is required for all Premium Apps.
Run
node index
It should run in localhost:8080
If you're running the sample in a different host or port, then you'll also need to change the 'clientIds' from the config file to one that you've created(Implicit Grant Type) in your PureCloud environment. This is so you could add your testing URL in the Authorized Redirect URIs for that OAuth Client.
Read More: https://help.mypurecloud.com/articles/create-an-oauth-client/
For a more in-depth look into the wizard sample codebase please go to:
https://developer.mypurecloud.com/api/tutorials/premium-app-example-wizard/
- Includes checking the organization if the Premium App is enabled.
- Step-by-step procedure of informing the user what the wizard is going to create in the org.
- Provides a one-step uninstallation that will undo everything the wizard has created/configured.
Going to the page docs/wizard/uninstall.html will run the deprovisioning of the Prremium App. This means deleting all the PureCloud objects (groups, roles, etc.) that were initially created by the tool.
-
The web page will use an implicit grant to authenticate with PureCloud.
-
The Dev Org Provisioning Tool is a tool used to provision some of the Genesys Cloud functionalites and easily access some features.
- Provision Telephony, Download Architect Template and Assign Developer Role are the main funtionalities.
By default the wizard app allows you to automatically provision the following PureCloud objects:
- Roles
- Groups
- Additional Integration Instances
- Oauth Client
- Data Tables
Depending on the Premium App's needs it may need any number of those objects. The only object that is almost always required is a role. At least one role should be created that has the permission for your app. This role will grant users access to to view and use the premium app fom within PureCloud.
The Wizard app is mostly built with vanilla HTML, CSS and JS. This makes it independent from any particular libraries.
The configuration file is the SSOT for the entire operation and also contains the details on what items are to be provisioned by the wizard.
./docs/wizard/config/config.js
The following values should be modified for production:
- Regional client ids for your app to be provided by AppFoundry.
- wizardUriBase
- Uri for the wizard tool.
- premiumAppURL
- the landing page of the actual Premium App.
- appName
- This is the unique id that is generated for your integration.
- prefix
- A string that will be prefixed to all the names of the provisioned PureCloud Objects. It is up to the discretion of the vendor but a good rule of thumb is just use the name of the Premium App itself.
- provisioningInfo
- An object containing the definition of objects to be created. Please consult the default config file and the sample-order.js for examples on how it should be formatted.
While the default layout is sufficient for the provisioning process, you are free and encouraged to change elements and styling to reflect your branding.
At the very least, Premium Apps are expected to replace the default logo with a logo of their app or company.
Image assets
docs/wizard/assets/img/
CSS
docs/wizard/styles/style.css
Some apps are simple to set up while some apps may require configuration not natively supported by the wizard tool. For feature requests for the wizard, feel free to open an issue in this Github repo. It would be the discretion of the developers (DevFoundry) whether to approve or reject feature requests.
Aside from the PureCloud Objects listed here you can create additional modules for other PureCloud object types. All of these modules are defined here:
./docs/wizard/scripts/modules/
Consult the folder README for creating new modules.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent