# 接入总览
接入企微中台需要做的事项:
- 以 iframe 的方式嵌入企微中台的页面插件。按照嵌入约定做和参数传递实现身份打通。 1.1 某些页面插件需要集成接入方的数据(例如:“渠道码”插件需要拉取组织架构)。这时,需要按此页面插件的要求实现响应的 API 供企微中台调用。并且提供 API 认证凭据给企微中台(因为调用过程将经过公网)。
- 申请企微中台的 API 调用凭据。以便在经过公网时完成安全认证。
- 以 API 调用方式注册应用。将租户信息、企微信息等在企微中台注册,拿到企微中台生成的应用 ID、企业 ID、租户 ID 并保存。后续将以应用 ID 为参数调用具体的企微中台能力 API,完成功能。
- 依照自身的需求,实现企微消息回调处理逻辑。并将回调 API 和其关注的消息注册到企微中台。
# 两种接入方式
企微中台服务组织(明源各 BU)可以以 2 种方式来接入企微中台:
- 采用企微中台提供的页面插件,嵌入到自己的页面中。这些页面插件已经打包好企微功能。
- 采用企微中台提供的企微能力 API,完全自己开发涉及企微的页面。
需要做的技术集成:
- 与企微中台站点之间的 SSO 打通。以便做好安全认证和身份传递。(接入方式 1 需要)
- 调用企微中台 HTTP API 时做好客户端认证。因为这部分调用是经过公网进行的。(接入方式 1 和 2 都需要)
- 提供必要的回调 HTTP API 供企微中台调用。并且实现认证机制。(接入方式 1 和 2 都需要)
# 企微中台应用
调用企微中台时一般都需要附带企微中台的应用 ID 参数,此数据由接入方在调用“注册自建应用” API 时获得。接入方记录企微中台的应用 ID 等信息与自身概念的映射关系。
建议是将调用集成到系统的企微参数配置功能内。当用户配置企微信息时检查是否已经在企微中台注册过自建应用(保存有企微中台应用 ID 及映射关系)。如果没有则依次注册企业信息和注册自建应用(API 说明请见下文)。
交互流程如下:
# 注册企业
# 注册应用
# 配置应用的回调地址
需将自建/代开发应用的地址配置为企微中台的回调地址:
自建/代开发应用的回调地址可通过接口获取企微企业回调地址 获取。
# 配置应用的客户联系能力权限
代开发应用:服务商勾选企业确认后,代开发应用即可调用,不需要再到企业管理后台客户联系配置可调用应用;
自建应用:需将自建应用配置到客户联系能力的可调用应用列表中,否则以自建应用的身份无权限调用外部联系人的相关接口,如下图:
# 获取应用
# 更新应用
# 获取企微能力
# 注册/更新企微能力
# 获取基础应用
# 注册/更新基础应用
# 其他开放 API
API 名称 | 定义 | 说明 |
---|---|---|
获取企业 | 查看 | |
获取应用的 access_token | 查看 | |
获取企微能力的 access_token | 查看 | |
获取基础应用的 access_token | 查看 | |
获取应用 jssdk 初始化配置 | 查看 | |
获取企业 jssdk 初始化配置 | 查看 | |
获取接入方租户对应的企微中台租户 | 查看 | |
获取企微中台出口ip列表 | 查看 | |
获取企微企业回调地址(含应用、事件、基础能力) | 查看 |