Skip to content

应用开发多企业授权H5使用手册

本手册适用于,开发者应用需要关联多个千里眼企业这类场景。
方案上,您的应用需实现一个跳转入口,用户点击该入口,您的应用引导进入应用开发多企业授权H5页的登录页面,用户使用千里眼超级管理员账号登录,并进行企业授权管理。

交互逻辑说明

整体交互流程图

第一步、应用已获取可用token

调用获取token接口,获取有效的token参数。

第二步、每次跳转前,都需获取一次校验码

调用获取链接访问授权码接口,每次请求授权页面链接,都需传入有效code。

第三步、应用自行拼接页面链接

拼接URL完整示例如下:
https://open.qly.cmviot.cn/grant?code=xxxxx&appId=xxxx&url=https%3A%2F%2F223.75.99.74%3A1443%2Fctm01hsgdpzh-web%2F%23%2Fcountry#login

说明如下,携带参数,必须按照示例的大小写格式:
1.链接域名页面地址:https://open.qly.cmviot.cn/grant,加上参数后末尾一定要加上#login。
2.appId:必填,本应用的appId,也就是应用Id。请进入应用配置,复制应用Id处展示的字符串。
3.code:必填,登录授权码,2分钟有效,使用后即失效。每次进入本授权H5,均需获取新的code。
4.url:选填,返回url。为满足用户在两边应用的使用体验,千里眼授权H5支持返回到您的应用。若无需返回,url可不传。

  • 4.1 原应用为App,url=dingtalk:// ,这里已返回钉钉为例,完整url一定补齐;特殊字符需要转义,进行encode
  • 4.2 原应用为网页,url=https:,特殊字符需要转义,进行encode;
  • 4.3 原应用为小程序时:需区分本H5是在微信内打开,还是非微信内打开。特殊字符需要转义,进行encode
访问H5的客户端是否支持返回url举例说明
微信客户端内不支持不传url字段用户本身就在微信内,可直接关闭本H5,此时仍在小程序内,体验上跟返回一样
非微信客户端支持weixin://dl/business/?ticket=<ticket>1、通过微信提供的“URL Scheme”功能生成ticket;
2、务必在小程序后台设置中开启“允许从外部浏览器打开”;
3、兼容性上,不是所有用户都支持直接从外部浏览器打开小程序,这取决于用户的设备和微信版本
4、生成的URL Scheme只有30天有效期,请及时更新
  • 小程序跳转,相关概念说明如下:
  1. URL Scheme在H5跳转小程序中的作用
    URL Scheme是一种特定的URL格式,用于在微信外部(如H5页面)打开小程序。它是实现H5跳转小程序的关键技术。

  2. 实现H5跳转小程序URL Scheme的具体步骤
    第一种方式 【后台配置】
    第一步 登录微信小程序后台
    在微信小程序管理后台,找到“开发”->“开发设置”中的“生成URL Scheme”入口。
    第二步 生成URL Scheme
    填写要跳转的小程序页面路径及参数,生成对应的URL Scheme。注意,生成的URL Scheme有有效期限制,一般为30天。
    第二种方式 【API动态获取URL Scheme】
    URL Scheme的生成接口地址为:https://api.weixin.qq.com/wxa/generatescheme。具体请百度使用方法。

第四步、应用跳转多企业授权H5页面

每次跳转时拼接的链接,都需先获取一次授权码,因授权码仅2分钟有效,拼接好链接后,需尽快跳转入本H5页面。

第五步、用户在H5页面进行登录/操作

这一步,用户在H5页面,完成企业对该应用的授权。

第六步、用户返回开发者应用,应用获取已获得授权的企业列表

每次用户点击过授权入口,均建议您的应用重新获取一次授权企业列表。 调用查询应用已授权企业列表接口。

第七步、所有API请求,请求头需加上企业字段

多企业应用,请求所有接口时,在header里加上字段“region”,传入本次要查询企业的企业编码。
若不传region字段,默认查询绑定企业的相关数据。
所有接口,是指包括【API】全目录下的接口。

应用开发多企业授权H5使用说明

使用上,用户进入本H5后,使用千里眼超管管理员账号进行登录。
登录后,可查询到用户管理的所有超管企业,以及每个企业对本应用的授权状态。对于未授权的,用户可进行主动授权,已授权的可操作撤销授权、修改时效等,也可以查看其企业对该应用的所有授权记录。

一、登录页面

支持手机号密码登录、验证码登录两种方式。 手机号密码登录验证码登录

二、主页面

上半部个人中心,展示本次申请授权的应用名称,展示本次登录的超级管理员账号,支持查询授权记录,支持退出登录。 主页

  • 点击应用名称,弹出应用详细信息,信息框内点击即复制全部信息; 应用信息

  • 点击账号信息,弹出账号详细信息; 账号信息

  • 点击授权记录,进入管理的所有企业,企业们对该应用的授权记录;该页面点击返回,回到主页面。 授权记录

  • 点击退出登录,可返回登录页面;

  • 点击返回原应用,可返回到原应用。 前提:访问本H5的链接中,url字段传入了完整路径(不支持微信内返回,参考上文中小程序部分解释)。

  • 企业卡片中,点击企业编码或者企业名称,代表复制信息; 账号信息

三、授权操作

  • 选择企业,点击授权,完成授权第一步,“阅读授权相关的隐私政策”,勾选同意后,可进入第二步 授权第一步

  • 授权第二步,用户可以选择授权时效,支持永久有效、指定失效日期。指定类,到期平台将自动撤销本次授权。选定时效后,点击完成授权,本企业状态便会自动更新为【已授权】。 授权第二步授权第二步

四、修改时效、撤销操作

  • 需要延长/缩短时效时,在主页找到企业,点击修改时效,选定指定或永久,设置完成,点击确定,主页上该企业的失效日期将会自动更新。 修改时效-指定修改时效-永久

  • 需要撤销授权时,在主页找到企业,点击撤销,请用户仔细阅读页面说明,即撤销后,该应用无法获取企业的新数据,但前期已获取到的老数据由应用自行处理,与千里眼应用开发平台无关。 撤销说明

开发者多企业授权管理

开发者登录应用开发平台门户后,可查看每一个应用已获授权明细。
路径上:登录后->控制台->能力开放申请下API对接->选择应用,点击应用详情,在超管授权企业部分,展示所有授权企业信息和授权到期时间。

开发者多企业管理

多企业方案能力适配说明

  • 平台API类请求,已支持多企业,使用方法请阅读多企业应用header需传region
  • Web SDK,支持多企业,使用方法请阅读多企业应用header需传region
  • APP SDK,不支持多企业,仅支持绑定企业,需求已有规划。
  • 消息订阅类,订阅时传入指定企业,订阅设置成功,便可收到不同企业产生的告警消息