第三方门户对接

优质
小牛编辑
116浏览
2023-12-01

微哨第三方渠道接入服务(以下简称微门户)是微哨基于微信、QQ等第三方平台开发的轻量级门户产品。它提供了部分基础的平台功能以及在第三方渠道使用微哨轻应用的能力,方便用户在没有微哨App的情况下使用微哨服务。

需要特别指出的是,由于第三方渠道的限制,与微哨App相比,微哨微门户仅能支持比较基础的平台能力,如果想获得更良好的体验,建议在运营推广方面主推微哨App。

企业微信部署

本章节适用于企业微信的接入部署。如果您仍在使用微信企业号,请联系我们的技术支持。

部署准备

请提前申请企业微信并进行相关认证。部署过程中需要从企业微信管理后台获取大量信息,以及进行配置操作,请确保您已经拥有要接入的企业微信的管理权限。

注意事项

在开始部署之前,如果企业微信通讯录中已经存在部分用户数据,部署完成之后需要单独将这部分人员和微哨中的用户进行匹配,以免用户无法正常使用相关微哨应用。您只需在微哨管理平台中下载更新模板,填写其中的“微信同步字段”(即微哨帐号),然后进行批量更新,即可完成关联。

企业微信后台配置

企业微信后台:https://work.weixin.qq.com/

1、基础配置

  • 我的企业 -> 企业信息:查看并记录企业ID。企业logo和企业简称请按需修改。
  • 连接微信 -> 微工作台:按需修改微工作台Logo和功能介绍,并保存邀请关注的二维码图片。
  • 管理工具 -> 通讯录同步:切换同步方式为“API接口”,权限修改为API编辑通讯录,并记录其Secret
  • 建议设置如下选项:
    • 管理工具 -> 成员加入:关闭“自动发送邀请”。
    • 我的企业 -> 申请加入设置:不在通讯录的成员,取消勾选“可被邀请加入企业”。
    • 我的企业 -> 设置:未使用成员提醒,取消勾选“开启”。
    • 连接微信 -> 微工作台:取消勾选“在微工作台底部可快捷打开企业微信客户端”及“成员使用微工作台时需要使用企业微信客户端”;勾选“限制所有成员在企业微信中查看通讯录及发起会话”(如果有此选项的话)。

2、内置应用配置

应用与小程序 -> 应用 -> 自建,按照如下步骤添加微门户所提供的基础应用(基础应用列表可参见附录【微门户内置应用信息】):

  1. 创建应用,填写应用名称、介绍、logo、可见范围。
  2. 点击应用进入详细设置,记录相应应用的AgentIdSecret
  3. 对于直达类应用(点击直接打开),工作台应用主页 -> 设置应用主页,填写相应应用的url,并勾选“在微工作台中始终进入主页”;对于对话类应用(可收发消息,类似微信公众号)自定义菜单 -> 设置,可按需要配置“跳转网页”类型的菜单。应用的相关信息可参见附录【微门户内置应用信息】
  4. 网页授权及JS-SDK -> 设置可信域名:填写可信域名xiaoyuan.weishao.com.cn。部分应用(如“发通知”)会使用到微信JS-SDK,需要进行域名归属验证,请按照页面提示,下载由微信后台生成的验证文件(注意不要修改其名称和内容!),并通过https://xiaoyuan.weishao.com.cn/dbg/upload上传,上传成功后完成验证即可。

3、其他应用配置

所有在微哨平台上架的应用都可根据权限在【微校园】应用中访问,如果外置于微信插件列表中,则无法控制访问权限。如果确实需要外置,可在 “企业应用 -> 自建应用” 中按照如下步骤添加:

  1. 创建应用,填写应用名称、介绍、logo、可见范围。
  2. 点击应用进入详细设置。

    • 对于主页型应用:工作台应用主页 -> 设置应用主页。url请参照附录微门户应用免登录接入链接规则生成并填写在此处。勾选“在微工作台中始终进入主页”;

    • 对于菜单型应用,自定义菜单,菜单类型选择“跳转网页”,url填写规则同上。

  3. 网页授权及JS-SDK -> 设置可信域名:填写可信域名xiaoyuan.weishao.com.cn

微哨管理端配置

第三方门户 -> 企业微信:

  1. 企业ID,填入企业微信后台配置中记录的企业ID
  2. 通讯录同步Secret,填入企业微信后台配置中记录的通讯录同步的Secret
  3. 同步企业微信用户规则,根据学校情况选择即可,默认为加密学工号。
  4. 应用配置,分别填入配置对应的微门户内置应用时所记录的AgentIdSecret
  5. 配置企业微信绑定页面,名称填入学校企业微信的名称,并上传其微信插件二维码图片(可在 “企业微信后台 -> 连接微信 -> 微工作台 -> 邀请关注” 处下载,建议下载中尺寸及以上的二维码图片)。
  6. 保存上述配置后,可点击“生成二维码”,下载微哨账号绑定向导页面的二维码图片,用于各类引导、推广活动。

微信公众号部署文档

本文档适用于微信公众号的接入部署。

部署准备

请提前申请并认证微信公众号。请确认要接入的公众号的所属行业为教育(一级行业)/院校(二级行业)。部署过程中需要从公众号管理后台获取大量信息,以及进行配置操作,请确保您已经拥有要接入的公众号的管理权限。

微信公众号及微哨管理端配置

微哨管理端配置

微哨管理端 -> 第三方门户 -> 微信服务号

  1. 在 微信公众平台 -> 开发 -> 基本配置 中查看 【开发者ID(AppID)】【开发者密码(AppSecret)】。注意:微信公众平台已经不再存储AppSecret,如果遗忘,无法再从公众平台查到,因此需要先在微信公众平台重置,然后在微哨管理端更新。
  2. App ID,填入 【开发者ID(AppID)】
  3. App Secret,填入 【开发者密码(AppSecret)】
  4. 生成服务器配置令牌,并复制,稍后填入微信公众号后台。(详见【服务器配置】)
  5. 配置通知消息:配置微哨通知推送到服务号后的消息内容和跳转,可参考管理端页面上的相关预览和说明,此处不具体介绍。
  6. 配置服务号信息:需要填写服务号名称和微信二维码,用于微哨App绑定服务号的页面显示。服务号二维码下载:微信公众平台 -> 设置 -> 公众号设置,点击头像下方的二维码图标,选择12cm以上尺寸的资源并下载保存到本地。
  7. 客户端绑定服务号方式:可选择是否开启随机码绑定方式。详见管理端页面说明。

微信公众号后台配置

微信公众号后台:https://mp.weixin.qq.com/

  • 服务器配置:微信公众平台 -> 开发 -> 基本配置:

    1. “IP白名单”中,添加call.weishao.com.cn的IP地址(可通过ping获得)。
    2. 启用“服务器配置”,其中“服务器地址(URL)”请填写https://call.weishao.com.cn/callback/index.php?m=wxservice&a=getMessage&domain=[domain],“令牌(Token)”请填写在管理端复制的令牌值。“消息加解密方式”请选择“明文模式”,其他模式暂不支持。
  • 模板消息配置:微信公众平台 -> 模板消息 -> 我的模板(如果找不到“模板消息”菜单,请点击“添加功能插件”,在插件库中查找并添加模板消息插件):

    1. 点击“从模板库中添加”,搜索“学校通知”模板。请确认搜索结果的模板编号为OPENTM204845041。在模板消息详情中点击添加,将其加入我的模板列表。
    2. 注意:这里需要确认模板列表中只存在一个名称为“学校通知”的模板,如果存在多个,请删除多余的模板。
  • 网页授权配置:微信公众平台 -> 设置 -> 公众号设置 -> 功能设置Tab -> 网页授权域名 -> 设置:

    1. 将“下载文件”处的txt文件下载保存到本地,请注意不要修改其名称和内容!
    2. 打开如下地址:https://xiaoyuan.weishao.com.cn/dbg/upload,将步骤1中下载的文件上传。
    3. 上传成功后,在微信网页授权域名页面中增加或修改域名,参照附录可信域名填写并保存。
  • 配置菜单:微信公众平台 -> 功能 -> 自定义菜单 -> 点击“+” -> 设置动作 -> 跳转到网页,根据需要设置相应的服务名称及链接即可。微门户内置应用的相关信息可参见附录【微门户内置应用信息】。如果希望外置某些应用,可参考附录微门户应用免登录接入链接规则生成相应链接。

QQ校园部署文档

本文档适用于QQ校园的部署。

注意:由于审核的缘故,QQ校园的消息推送目前无法保证时效。

部署准备

请提前申请QQ校园,并确保您拥有QQ校园管理平台的高级权限管理员。

QQ校园配置

QQ校园管理平台:https://uni.mp.qq.com

  • 在 QQ校园管理平台 -> 开发者模式 -> oAuth2.0网页授权 中,开启“授权回调域名”,并参照附录可信域名,填写回调域名。
  • 配置菜单:目前QQ校园号底部默认内置“服务大厅”菜单,该菜单项及其页面无法修改,但可通过后台配置所显示的应用(九宫格菜单);除“服务大厅”外,还可通过自定义菜单添加其他菜单项。微门户内置应用的相关信息可参见附录【微门户内置应用信息】

微哨管理端配置

  • 在 QQ校园管理平台 -> 开发者模式 中查看 【应用ID】【应用密钥】
  • 微哨管理端 -> 第三方门户 -> QQ智慧校园:
    1. QQ智慧校园应用ID,填入 【应用ID】
    2. 应用凭证密钥Secret,填入 【凭证密钥Secret】

其他外置应用

所有在微哨平台上架的应用都可根据权限在【微校园】应用中访问。对于需要外置于QQ校园(校园号菜单或服务大厅九宫格)的应用(其可见权限应当是“所有用户可见”),可通过QQ校园后台或联系客服进行配置。

应用地址请参照附录微门户应用免登录接入链接规则生成即可。

FAQ

Q:通知/订阅消息发送后为什么在QQ中很久也收不到?

A:QQ校园目前的消息推送可能存在审核机制,由于审核时效的不确定,导致我们推送的信息也无法及时到达。如果对此有疑问,请联系QQ校园客服进行咨询和反馈。

钉钉部署文档

本文档适用于钉钉的部署。

部署准备

请提前在钉钉申请注册企业,并确保您拥有企业的管理员权限。

钉钉对接需要在地端部署微哨的微门户服务,请联系项目实施经理进行部署。

钉钉配置

钉钉管理后台:https://oa.dingtalk.com/

微校园应用

  • 在 钉钉管理后台 -> 工作台 中,点击“+自建应用”,进入钉钉开放平台创建应用,其中“开发方式”请选择“企业内部自主开发”。
  • 下一步:“开发模式”请选择“开发应用”,“开发应用类型”请选择“微应用”。“服务器出口IP”请填写地端微门户服务所部署的服务器出口IP,“应用首页链接”请参照附录【微门户内置应用信息】 的“微校园”地址,将https://xiaoyuan.weishao.com.cn替换为地端微门户域名或IP即可。

其他应用

  • 在 钉钉管理后台 -> 工作台 中,点击“+自建应用”,进入钉钉开放平台创建应用,其中“开发方式”请选择“企业内部自主开发”。
  • 下一步:“开发模式”请选择“快捷链接”,“应用首页链接”可参照附录【微门户内置应用信息】微门户应用免登录接入链接规则,将https://xiaoyuan.weishao.com.cn替换为地端微门户域名或IP即可。

自定义工作台

有些客户会希望直接将微校园门户设置为钉钉的工作台,不再使用钉钉原生的工作台,实现此效果需要用到钉钉的自定义企业主页的功能:钉钉管理后台 -> 企业主页。

  • 如果学校尚未进行钉钉的企业认证,请根据页面提示,提交相关材料,进行企业认证。
  • 如果学校已经进行过企业认证,请在页面选择“链接企业现有首页”,并根据需要配置工作台tab的显示名称,保存后会进入到开放平台的工作台配置页面。
    1. 点击“创建工作台”,填写相关信息(参照上面的“微校园应用”相关配置)。
    2. 提交审核。请按照页面相应提示填写相关信息。

微哨管理端配置

  • 钉钉管理后台 -> 工作台 -> 微校园应用右上角菜单 -> 设置,查看微校园应用的应用信息(点击“查看详情”),记录 【AppKey】【AppSecret】
  • 钉钉开放平台 -> 首页,记录 【CorpID】
  • 微哨管理端 -> 第三方门户 -> 钉钉:
    1. Corp ID,填入 【CorpID】
    2. App ID,填入 【AppID】
    3. App Secret,填入 【AppSecret】

易班部署文档

本文档适用于易班的部署。

部署准备

请提前申请开通易班,并确保您拥有易班管理平台的管理员权限。

易班配置

易班开放平台:https://open.yiban.cn/

  • 在 易班开放平台 -> 管理中心 -> 轻应用 中,根据需要点击“+创建轻应用”创建相关应用,按照页面提示填写相关信息即可。其中,“应用地址”请按照如下规则进行填写:

    https://xiaoyuan.weishao.com.cn/yiban/oauth/[domain]/URLEncode([目标路径])

    其中,domain请替换为微哨平台为学校分配的唯一标识;目标路径相当于附录【微门户内置应用信息】pathquery的结合,即:目标路径 = [path]?[query]。注意附录中query为JSON格式参数,需转换为Query String格式(形如a=xx&b=yy&c=zz)。

    示例1:在温州大学(唯一标识wzu)易班平台上架“微校园”,其应填写的应用地址为:https://xiaoyuan.weishao.com.cn/yiban/oauth/wzu/home

    示例2:在温州大学(唯一标识wzu)易班平台上架微哨应用“一卡通”外置,假设其在微哨管理端注册的App Key为abcde12345,则其应填写的应用地址为:https://xiaoyuan.weishao.com.cn/yiban/oauth/wzu/link%3fid%3dabcde12345

微哨管理端配置

  • 在 易班开放平台 -> 管理中心 的轻应用列表中查看相应应用的详情,记录 【AppID】【AppSecret】【开发信息 - 站内地址】
  • 微哨管理端 -> 第三方门户 -> 易班 -> 添加:
    1. 应用名称,填入应用的名称。
    2. App ID,填入 【AppID】
    3. App Secret,填入 【AppSecret】
    4. 站内地址,填入 【开发信息 - 站内地址】
    5. 应用地址,填写 【目标路径】。保存后可看到完整的应用地址,应与易班平台所配置的地址相同。

外置应用

和其他接入渠道类似,接入微哨的应用也支持直接外置于易班平台。由于易班平台的限制,其“应用地址”字段长度不能超过100字符,因此无法直接在参数中携带应用的URL。为了解决上述问题,对于易班渠道,可以使用如下规则进行应用外置链接的生成:

https://xiaoyuan.weishao.com.cn/yiban/oauth/[domain]/link%3fid%3d[app_id]

其中,domain请替换为微哨平台为学校分配的唯一标识,app_id处应填入对应应用的App Key。可参考上面“易班配置”一节中的示例2。

附录

微门户接入渠道标识

渠道名称标识
企业微信wx
微信公众号wxmp
QQ校园qq
钉钉dingtalk
易班yiban

微门户内置应用信息

1、微哨通知

  • 应用类型:对话型
  • 应用地址:
名称链接
所有通知https://xiaoyuan.weishao.com.cn/[channel]/oauth/[domain]?path=notice
我的通知https://xiaoyuan.weishao.com.cn/[channel]/oauth/[domain]?path=notice%2f0
订阅消息https://xiaoyuan.weishao.com.cn/[channel]/oauth/[domain]?path=notice%2f2
发通知https://xiaoyuan.weishao.com.cn/[channel]/oauth/[domain]?path=notice%2fcompose
已发通知https://xiaoyuan.weishao.com.cn/[channel]/oauth/[domain]?path=notice%2fsent

其中,domain请替换为微哨平台为学校分配的唯一标识,channel请替换为相应第三方渠道的标识

2、微校园

  • 应用类型:直达型
  • 应用地址:

    https://xiaoyuan.weishao.com.cn/[channel]/oauth/[domain]https://xiaoyuan.weishao.com.cn/[channel]/oauth/[domain]?path=home

    其中,domain请替换为微哨平台为学校分配的唯一标识,channel请替换为相应第三方渠道的标识

3、个人资料

  • 应用类型:直达型
  • 应用地址:

    https://xiaoyuan.weishao.com.cn/[channel]/oauth/[domain]?path=bio

    其中,domain请替换为微哨平台为学校分配的唯一标识,channel请替换为相应第三方渠道的标识

4、智能问答

  • 应用类型:直达型
  • 应用地址:

    https://xiaoyuan.weishao.com.cn/[channel]/oauth/[domain]?path=smartqa

    其中,domain请替换为微哨平台为学校分配的唯一标识,channel请替换为相应第三方渠道的标识

    注意:智能问答为可选模块,在配置前请先确认购买的平台服务包中是否包含智能问答模块。

5、账号绑定/解绑

  • 应用类型:直达型
  • 应用地址:
名称链接
账号绑定https://xiaoyuan.weishao.com.cn/[channel]/oauth/[domain]?path=whistle%2fbind
账号解绑https://xiaoyuan.weishao.com.cn/[channel]/oauth/[domain]?path=whistle%2funbind

其中,domain请替换为微哨平台为学校分配的唯一标识,channel请替换为相应第三方渠道的标识

微门户应用免登录接入链接规则

接入微哨微门户的应用,如果希望外置于微门户之外(例如:配置到微信公众号菜单),并且实现免登录效果,请按照如下规则生成URL:

https://xiaoyuan.weishao.com.cn/[channel]/oauth/[domain]?path=link&query=%7B%22id%22%3a%22[app_id]%22%2C%22url%22%3A%22[url]%22%7D

其中,channel请替换为相应第三方渠道的标识domain请替换为微哨平台为学校分配的唯一标识,app_id处应填入对应应用的App Key,url处应填入应用的地址(需进行URLEncode)。

如果应用需要调用微哨开放平台API,其在微哨管理端上架的地址应使用微哨OAuth进行接入,步骤如下:

  1. 应用地址URL encode。以“一卡通”为例,正式环境为: https://lightapp.weishao.com.cn/check/ecard

  2. url编码后为: https%3a%2f%2flightapp.weishao.com.cn%2fcheck%2fecard

  3. 拼接OAuth code模式地址: https://api.weishao.com.cn/oauth/authorize?client_id=[app_key]&redirect_uri=[app_url]&response_type=code&scope=all&state=[domain], 其中,app_key填入应用的App Key,app_url填入步骤1得到的url编码后的应用地址,domain填入学校的标识。

我们提供了链接生成工具,可快速生成所需的接入链接。