腾讯云智能数智人接入规范-配置端 iPaaS 接入-文档中心-腾讯云

一、集成方工作清单
1. 云账号托管能力建设：
客户要在云控制台生成 aksk，然后配置到集成商的数据库里面，并且授权给集成商进行调用；
托管客户 aksk 及映射自有账号体系和 uin 的对应关系；
2. 数智人平台菜单框架开发及集成：
集成商通过菜单接口获取菜单，集成数智人平台的页面；
集成数智人接口获取客户购买的菜单范围、生成菜单页面访问的 token 追加在 url 之后；
3. token 回调检查接口：
集成商进行 token 回调，返回客户托管的 aksk 信息；
当数智人页面打开时，会拿到 url 上的带参 token，回调集成商系统检查 token 合法有效性，并希望集成商返回该 token 对应的客户已托管的 uin、ak、sk 信息。
二、集成过程说明
1. 客户 uin、aksk 托管。
﻿
﻿
2. 集成商系统主框架加载
﻿
﻿
3. 集成商系统内打开数字人页面
﻿
﻿
三、页面嵌入规范
嵌入方式
通过 iframe 集成，使用下面的 URL 在客户业务系统中嵌入数智人平台页面。
URL： https://xiaowei.cloud.tencent.com/ivh?iframe=true&from={from}&token={token}#/application
参数：
from 指来源系统标识，由数智人侧分配；
token 由集成商生成，背后对应客户的 uin、aksk，当访问页面时数智人侧会回调接口通过 token 换取 uin 和 aksk。
嵌入范围
目前数智人平台支持以下菜单页面的嵌入（持续更新中），完整平台功能范围见数智人平台操作指引。
音视频播报列表
音视频制作页面-编辑
音视频制作页面-新建
会话互动列表
交互大模型页面
运营管理
资产管理
代码示例
menuData = [
          {
            "Code": "VideoBroadcastList",
            "Url": "/ivh/#/application?iframe=true&token=xxx",
            "Name": "音视频播报列表"
          },
          {
            "Code": "VideoBroadcastMake",
            "Url": "/ivh/#/bvh_page?iframe=true&page=xxx&name=xxx&token=xxx",
            "Name": "音视频制作页面-编辑"
          },
          {
            "Code": "VideoBroadcastMakeNew",
            "Url": "/ivh/#/bvh_page?iframe=true&page=xxx&token=xxx",
            "Name": "音视频制作页面-新建"
          },
          {
            "Code": "InteractionList",
            "Url": "/ivh/#/application?iframe=true&token=xxx",
            "Name": "会话互动列表"
          },
          {
            "Code": "InteractionCloudAI",
            "Url": "/ivh/#/lke/robot-manage/knowledge/qa-source?iframe=true&vkey=xxx&botid=xxx&token=xxx",
            "Name": "交互大模型页面"
          },
          {
            "Code": "OperationManagement",
            "Url": "/ivh/#/analysis?iframe=true&token=xxx",
            "Name": "运营管理"
          },
          {
            "Code": "AssetManagement",
            "Url": "/ivh/#/asserts_management?iframe=true&token=xxx",
            "Name": "资产管理"
          }
        ];
token 回调检查接口规范
协议：https
请求method：POST
请求content-type：application/json
请求body：
{
    "token": "token"，// 集成商生成，在页面嵌入时在url中追加的token参数。
}
﻿
返回结构要求
{
      "request_id": "request_id", // 唯一请求id
      "code":0,
      "message":"ok",
      "merchantID": "merchantID",   // 集成商id，腾讯分配，在页面嵌入时在url中追加的from参数。
      "merchantUin": "merchantUin", // 托管的客户uin
      "MerchantSubAccountUin": "MerchantSubAccountUin", // 托管的客户子账号uin
      "sessionToken":{
          "secretId":  "secretId", // 秘钥id ，建议使用临时秘钥返回
          "secretKey":  "secretKey", // 秘钥key，建议使用临时秘钥返回
      }
}
﻿
接口开发完成后，提交给产品运营人员进行相关配置。
四、页面样式规范
可配置样式范围
针对 iframe 嵌入的页面，目前已支持一键更换主题色、logo 配置的功能。
配置方式
具体能力详见下面的配置内容：
{
    "iframeConfig": true, // 表示当前是iframe潜入，并且支持换肤能力
    "hideHeader": true, // 隐藏数智人平台的头部内容
    "hideSidebar": true, // 隐藏数智人平台的左侧菜单内容
    "logoUrl": "/logo.png",// 更换数智人头部的logo信息
    // 页面相关的tab可以通过权限控制隐藏显示。
    // 主题色配置
    "theme": {
      "primaryColor": "green",
      "primaryColorHover": "green",
      "primaryColorActive": "darkred",
      "iconColor": "green"
      // ....其他antd支持的主题样式配置。
      }
 }
﻿
接入规范

本页目录：

一、集成方工作清单

二、集成过程说明

三、页面嵌入规范

嵌入方式

嵌入范围

代码示例

token 回调检查接口规范

四、页面样式规范

可配置样式范围

配置方式
