Integration via API - Co-Browsing
This usecase describes example steps of the configuration and API usage which are needed to integrate the CoBrowsing / LiveView functionality in another system.
1. Configuration
In the plugin configuration of the backend, activate the LiveView plugin. We used the following configuration in our example.
| Config | Value | Description |
|---|---|---|
| Privacy | Mask user inputs | We want to mask all user inputs which happen on our page. |
| Optin | Visitor | We want that the user clicks on a button which starts the CoBrowsing session. |
2. Script Implementation
The JavaScript has to be integrated in each webpage where we want to cobrowse.
Learn how to implement the LiveView on your page.
3. Start and stop the CoBrowse / LiveView session
We will start or stop the LiveView session with these functions CV.cobrowse.start() and CV.cobrowse.stop(). Therefore we simply implement a button where the user can click on it and starts the session.
If you don't want a button for a optin, you can simply deactivate the option configuration at step 1.
How long does a session last? Go to page
4. Generate a join URL for the agent
After the session is successfully started, we can now generate a public URL where the agent can join the session. For this we need the shareId or the sessionId to join generate the URL through the REST API.
Authenticate and generate an API token Go to documentation
Afterwards we can simply send a GET request to the API endpoint which is described in the following link. In front of that we have to transfer the shareId or the sessionId to the server to identify the session and afterwards we can generate the URL which can be opened without authentication.
REST API to generate a public join URL
This is a unique URL which is signed with a token and is always bound to the session with the given ID.