Console portal integration
Overview
One main reason that products onboard to Console is to make use of Console’s portal. Console’s web portal is a one-stop location for agency users to manage configurations and administrative workflows across multiple products. By integrating your product’s web application into Console, this helps create a unified interface for agency users and reduces friction when switching between services.
If your product has synergy with the other onboarded products in Console, you can even setup cross-product workflows to provide a more seamless agency user experience across the products.
Benefits
There are numerous benefits of integrating your product’s web application into Console. Some benefits include:
- not needing to handle login/logout or session management.
- reduced development effort by using existing common services.
- providing a more unified experience to agency users since they come to one central location to perform all configuration and management.
Onboarded Products
The following products have integrated their web applications into Console
- TechBiz
- StackOps
- SHIP-HATS
- Security Centre (CodeScape/CloudScape)
- TechPass (partially)
- More products to come…
Integration checklist
To integrate your product’s web application into Console, complete the following steps:
Create a product on Console.
Start feature development of your web application.
2.1. Use Console’s navbar and footer components as the skeleton for your application.
2.2 Ideally, use SGDS V3 for the UI to provide a consistent look and feel inside Console.
2.3 Use Console’s common session management in your backend servers to validate the logged in user.
2.4 (optional) If your product has need of user roles for access control, you may choose to setup your application roles in your TechPass app associated with Console.
Deploy your web application on your cloud account.
3.1 Work with the Console team to establish network connectivity between Console’s AWS account to your servers.
3.2. Configure Console’s NGINX routing to route your product’s requests to point to your web application servers.
(optional) Grant your teammates product admin or ops roles in your TechPass app to give them access to manage your product on Console.
To integrate subscription/billing on Console
5.1 Understand the subscription structure
To subscribe to any product, agencies must have a subscription account. A subscription account allows agencies to add resources to the account, manage subscription plans and view billing details. A resource is defined by Product. E.g. StackOps’s resource is a deployment whereas Apex’s resource is a Organisation.
Webhooks are fired based on subscription events (subscription created, resource created etc) so your product can listen to these webhooks and provision the necessary for your users.
5.2 Find out how your pricing model can fit into Console billing flow
There are 2 common types of pricing model:
Usage based (Pay per use): Console will poll the usage based on the resources created in Console via Usage API. Product will have to return the usage value to Console based on a response schema defined by Console. Console will use the response to generate the invoice for each account on the 8th of every month.
Non-usage based (Fixed quantity): Console will use the number of subscriptions multiply by the unit cost. E.g. Subscription account subscribe to 5 licenses. Each license costs $100 a month. Console will generate an invoice that displays 5 licenses x $100 = $500 on the 8th of every month.
5.3 Before you start the technical implementation, read the networking pre-requisites here and inform Console team to set up the necessary configuration.
5.4 To know more about existing webhooks or API we provide, you can find them here:
