客户端 SDK 配置指引

最近更新时间:2024-09-14 10:35:51

我的收藏

客户端 SDK 参数介绍

注意:
配置过程中生成的下表参数需保存,用于后续 SDK 对接。RSA 私钥和 ServiceAccount 参数腾讯侧生成后不会保存到后台,如果遗失无法找回,只能重新生成。
参数名称
描述
用途
获取方式
SDK ID
SDK 应用的唯一标识。
生成 SDK Token(SDK 初始化入参)和 ID Token(SDK 登录入参)所需的iss 字段。
SDK初始化接口的入参。
iDaaS 配置 SDK 认证源所需的 Issuer 字段。

企业管理 > 高级 > SaaS SDK > 应用编辑配置页面获取
SDK Secret
SDK 密钥参数,为保证应用安全性,请将密钥信息部署到 Server 端,不可由终端程序持有保管。
用于生成 SDK Token(SDK 初始化入参),加密方式为 HS256。
企业管理 > 高级 > SaaS SDK > 应用编辑 配置页面获取
SSO URL
SDK 登录的域名,格式为:
https://{SSO域名}-idp.idp.id.meeting.qq.com/cidp/custom/ai-123/{ai-456}?id_token=
和 ID Token 参数拼接后作为 SDK 登录接口的入参。
该域名目前需要手工拼接,前面的部分(https://{SSO域名}-idp.idp.id.meeting.qq.com/cidp/custom/ai-123)为 iDaaS 配置 SDK 认证源页面的回调链接,ai-456 参数为企业管理 > 高级 > 单点登录页面的应用 ID。
RSA 公私钥
公钥保存在腾讯后台,私钥客户自己保存。为保证应用安全性,请将密钥信息部署到Server端,不可由终端程序持有保管。
用于生成 ID Token(SDK 登录入参),加密方式为 RS256。
可以在企业管理 > 高级 > SaaS SDK > 应用编辑页面获取生成的公私钥,然后将公钥内容填写到 iDaaS 配置 SDK 认证源页面。腾讯后台不会保存私钥,如果私钥遗失需要重新生成并在腾讯侧配置对应的公钥。
也可以自行生成2048位 pkcs8 格式的密钥,然后将公钥内容填写到 iDaaS 配置 SDK 认证源页面。
iDaaS API 请求域名
当使用 iDaaS API 方式同步账号时,使用该域名发送 API 请求,域名格式为:https://{SSO域名前缀}-admin.id.meeting.qq.com/contacts/
调用 iDaaS API 的请求域名
该域名目前需要手工拼接,{SSO域名前缀}企业管理 > 高级 > 单点登录页面获取。
ServiceAccount
iDaaS API 密钥
用于对 iDaaS API 请求进行签名
在 iDaaS 通讯录接口调用入口创建凭证获取,后台不会保存该密钥,如果遗失需要重新创建。

客户端 SDK 参数配置

说明:
联系商务开通 SDK 配置后,超管登录到腾讯会议企管平台,需要对 SaaS SDK 应用和 iDaaS 进行配置。

SaaS SDK 应用配置

说明:
这里配置后可以获取 SDK ID、SDK Secret 和 RSA 公私钥等参数信息。
1. 参考 如何切换企业账号模式 将账号模式设置为第三方认证源对接(已经是第三方认证源对接方式可跳过)。
2. 可以在企业管理 > 高级 > SaaS SDK 看到 SDK 配置的入口(如果没有刷新一下浏览器),单击进去后配置 SDK 参数。



3. 单击创建应用



4. 设置应用参数,并且创建密钥对。



5. 
创建完密钥对
后,浏览器会自动下载私钥文件,如果没有下载,请先解除浏览器弹窗限制,然后重新生成密钥对。将公钥复制后和私钥一起保存供后续使用。



6. 单击返回应用列表,将刚才创建的 SDK 应用设置为启用状态。



7. 单击编辑进入
应用编辑页面
,然后单击 iDaaS 配置进入 iDaaS 参数配置部分。




iDaaS SDK 认证源配置

说明:
这里配置后可以获取到 SSO URL 参数,该参数由配置 SDK 认证源页面的回调链接参数和企业管理 > 高级 > 单点登录页面的应用 ID 参数拼接而成。
1. 在 iDaaS 配置首页单击认证源配置进行 SDK 认证源配置。



2. 单击添加认证源并在下拉框中选择 SDK 认证源



3. 单击确定创建 SDK 认证源。



4. 配置 RSA 公钥和 Issuer,并生成免登地址前缀。RSA 公钥填写为前面 SaaS SDK 应用配置生成密钥对 中的公钥,Issuer 填写为 SaaS SDK 应用编辑 页面中的 SDK ID 参数。其他参数默认配置即可。同时保存本页面的
回调链接
(https://{SSO域名}-idp.id.meeting.qq.com/cidp/custom/ai-a91b92f890784557a25264b8433143ea)。然后单击确定



5. 账号关联设置和下图配置保持一致。



6. 完成认证源相关配置以后,需要打开配置才可以使用,无需设置默认。



7. 进入企业管理 > 高级 > 单点登录页面,将应用 ID 参数和前面的 SDK 认证源回调链接 拼接,得到 SSO URL 参数(https://{SSO域名}-idp.id.meeting.qq.com/cidp/custom/ai-a91b92f890784557a25264b8433143ea/ai-dffdbcf279xxxxxxxxxxxxx5e?id_token=),保存起来供后续 SDK 对接使用。




iDaaS API 通讯录接口调用配置

说明:
如果企业不通过 iDaaS API 同步账号到腾讯会议后台,可跳过。这里配置后可以获取 iDaaS API 请求域名和 ServiceAccount 参数,用于 iDaaS API 接口调用和鉴权。
1. 在 iDaaS 配置首页单击通讯录接口调用



2. 单击创建凭证,填写相关信息然后单击确认



3. 将 ServiceAccount 信息保存到本地,然后关闭弹窗。



4. 进入企业管理 > 高级 > 单点登录页面,这里 SSO 域名前缀为 eastXXXpc,可以得到 iDaaS API 请求域名为 https://eastXXXpc-admin.id.meeting.qq.com/contacts/。




数据自动同步配置

1. 在 iDaaS 配置首页单击同步



2. 单击腾讯会议



3. iDaaS 向腾讯会议的自动同步范围选择。
说明:
配置 IDaaS 根部门。
不用配置离职部门,该部门存放离职/被移除人员。
不要配置人员,默认同步根部门下人员。
单击 UD人员镜像名称



进入后单击三个点图标 > 编辑



单击部门配置的修改图标。



勾选 iDaaS 根部门,不要勾选离职及无部门人员。



将部门和人员都勾选上。



4. 近实时同步配置。
说明:
近实时同步根据数据量来决定速率3~4个/秒,单个账号最晚10分钟之内完成同步。
此处的定时同步配置忽略,保持使用后面配置的定时任务即可,避免重复配置。
单击配置进入。



打开近实时同步开关。



5. 定时同步配置。
说明:
若上游可定时同步数据,则可选择配置定时同步任务来完成数据同步,建议错峰配置,避免整点配置,每12个小时同步作为同步频率。
UD 人员镜像:是 IDaaS 通讯录平台的账号数据(上游数据源/调用 IDaaS-API 所同步创建同步)。
腾讯会议人员镜像:同步给腾讯会议的账号数据。
单击自动同步设置选项。



按下图创建自动同步任务。