Implemented OEM & Embedded feature
Introduction
Sapper OEM
OEM capabilities mean that the OEM partners can manage customers' details, usage, subscriptions, and other statistical data. The Sapper OEM program supports various offerings for several products. You can build an optimized ecosystem, and provide data, and products with application integration capabilities. This saves the team from manual user management and maintenance and allows them to focus on core performance.
Sapper Embedded
Sapper's embedded implementation provides customers and partners with a seamless end-user experience. It also helps to build and manage integrations directly from their products using Sapper's user-friendly interface. The fully embedded connections widget allows you to embed all pages and components on the Sapper platform into an iFrame integrated into the client platform UI.
- 1 Introduction
- 1.1 Sapper OEM
- 1.2 Sapper Embedded
- 2 Overview
- 2.1 Sapper OEM
- 2.2 Types of Sapper OEM
- 2.3 Features of OEM Tenant
- 2.4 Admin Dashboard
- 2.5 Customer Management
- 2.6 Benefits of Sapper OEM
- 3 Sapper Embedded Overview
- 3.1 Benefits
- 3.2 How to use Sapper Embedded?
- 3.2.1 Client Script
- 3.2.2 Generate handshake token
Overview
Sapper OEM
Types of Sapper OEM
Sapper OEM support the core two types of OEM tenant, i.e., OEM Tenant and OEM customer Tenant.
OEM tenant is a client of Sapper Partners. Where OEM admins can create tenants and view customer dashboards seamlessly.
OEM customer tenant is a tenant created by an OEM administrator.
Features of OEM Tenant
OEM Tenant will have the following features:
The foremost features is tenant management screen. This features will allow you to create a new tenant for the OEM’s customer. you will also get the features for viewing all the tenants. You can also opt for the OEM editing and deleting or disabling tenants feature based on your requirements.
You will get the reporting/dashboard features in this tenant. In the dashboard you will be able to find the data related to the total tenant, automations, executions, connections and record processed details. You will also get few charts, that represents the success and failure rate of the executions, automation, connection and record processed statistical data.
In the OEM tenant you will be able to configure a default theme for all your customers. That will allow your each customers to choose their unique theme based on their requirement.
The OEM Tenant is associated with the core two factors i.e., Admin Dashboard, and Customer Management.
Admin Dashboard
In the Admin Dashboard you can have a snapshot of a total number of users, automations, executions, connections, and all the actions that have been performed in the Sapper automation portal. You can look at data about automation execution, status, and other tasks in graphical form in a statistical manner. It will allow you to get a better understanding related to the executed automations and connections. You will be also able to get the feature's of advanced search allows filtering by tenant, date range, automation name, and list of items.
Customer Management
In the client management section the admin will expeditiously manage all the end-users accounts; i.e - add / modify, deactivate, check usage metrics, apply subscription limit or amendment the arrange for a user. Admin will monitor finish users’ execution history, transfer their logs & give support for breakdown problems. There also are practical limitations & restrictions that may be applied as per the need.
Benefits of Sapper OEM
The sapper OEM tenant is associated with various benefits. Those are mentioned below:
Helps to manage and monitor usage, execution history, logs, and analyze data for the organization's end customers with more productivity than hand-coding.
Fetch data from your end-customers applications and other third-party data sources to streamline your ability to deliver new value-added data services.
End-Customer Usage Tracking Audit tracking of all platform interactions including data integrations/connections executed along with all the actions are available via reports, logs & help them to resolve issues.
Sapper will provide OEM tenants to only Partners, furthermore, Partners can resell it to their customers & can directly deal with them.
Sapper Embedded Overview
Embedded
Embedded and OEM are closely related. Sapper OEM Embedded Analytics refers to third-party data analysis software that has been designed to be sold to other companies to provide customers with OEM Embedded Product Packages. Integration of Sapper and customer platform is done via iframe. This is a native way to embed one web application into another web application through one browser. We also provide a Sapper embedded client script that aims to simplify synchronization between Sapper (embedded via an iframe) and your web application / product.
Benefits
It offers the possibility to build your own integration and ensures full authority over the client account according to the needs of the client.
It enables the most seamless migration from products to Sapper and is built into its own user interface.
How to use Sapper Embedded?
Click on the Embedded Token from the Tenant/account admin option navigated from the Sapper home page.
2. Once you click on the embedded token option , it will redirect you to the embeded token page from where you will be able to view the existing token’s along with the option for generating a new token.
3. Click on the generate token, and the form will be appear on the screen. Now provide a name and generate a token. Please make sure that this token is completely safe and not revealed to anyone.
4. Once you generate the token you will get a client script link for accessing it . You can copy it based on your requirements.
Client Script
Here is the client script which you needs to add to your web application:
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Sapper</title>
<base href="/">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="favicon.ico">
<style type="text/css">
html {
overflow: auto;
}
html,
body,
div,
iframe {
margin: 0px;
padding: 0px;
height: 100%;
border: none;
}
iframe {
display: block;
width: 100%;
border: none;
overflow-y: hidden;
overflow-x: hidden;
}
</style>
</head>
<body>
iframe src=" https://automation-test.sapper.ai/#/embedded/automation?token=<handshake token>"
frameborder="0"
marginheight="0"
marginheight="0"
width="100%"
height="100%"
scrolling="no">
</iframe>
</body>
</html>
Generate handshake token
In the above code, you just need to generate & pass <handshake token> dynamically. The validity of the handshake token is 2 hours.
Here are the API details to generate the handshake token. We recommend generating a handshake token through the backend so that the main token is not exposed to the end-user.
API URL | This is the API URL to generate the handshake token. | |
Method | GET | GET is used to fetch something from the server. |
Query Parameter |
| You can provide any unique id. Sapper will track all the actions against this id for audit. |
Header Parameter |
|
|
Response | {
|
|
5. If you want to access the existing token then you can find it in the Embedded Token tab. Here you will get all the details related to the token, i.e., name of the token, client script link, created date, end date and actions.
6. In the action section you will get the option for editing and deleting the embedded token based on your requirements.
Input | Description | Examples |
|---|---|---|
Name | In the name section you will need to add the name of the embedded token. | Sample |
Token | In this field you will get the token link. | Zt0DwIBAsgbUNB8/6TceeioSN8q4hwA7YoT+cFI/V6Dzp8PZ/X1aAwp92UsUI+sigEERMITQdbW8zfl9bHReWw== |
Created Date | This field is associated with the information of token creation date. | 5/26/22, 3:12 AM |
End Date | This field is associated with the end date or expire date of the token. | 5/26/22, 5:12 AM |
Action | In this field you will be able to get the two options for editing or deleting the created token. |
|