知识库
通过 API 集成 - 共同浏览
上次修改时间: 2024年3月15日
此用例描述了在另一个系统中集成CoBrowsing / LiveView功能所需的配置和API使用示例步骤。
1. 配置
在后端的插件配置中，激活LiveView插件。 在示例中，我们使用了以下配置。
| Config | Value | Description |
|---|---|---|
Privacy | Mask user input | We want to mask all user inputs which happen on our page. |
Optin | Visitor | We want the user to click on the button that starts the CoBrowsing. |
3. 共同浏览/实时视图会话的开启和停止
我们将使用以下函数CV.cobrowse.start（）和CV.cobrowse.stop（）启动或停止LiveView会话。 因此，我们仅实现了一个按钮，用户可以在该按钮上单击并启动会话。
如果您不希望选择按钮，只需在步骤1停用选项配置即可。
会议持续多长时间？ 前往页面
4. 生成代理的加入URL
成功启动会话后，我们现在可以生成一个公共URL，代理可以在其中加入会话。 为此，我们需要shareId或sessionId来加入，以通过REST API生成URL。
验证并生成API令牌 前往文档
之后，我们可以简单地将GET请求发送到API端点，如以下链接中所述。 首先，我们必须将shareId或sessionId传输到服务器以标识会话，然后我们可以生成无需身份验证即可打开的URL。
这是一个唯一的URL，该URL用令牌签名，并且始终绑定到具有给定ID的会话。