对接步骤
步骤一:获取 token
前往开发教程-服务端 API 对接,根据文档中对接步骤获取 token。
步骤二:获取链接访问授权码
调用接口获取链接访问授权码,获取授权码 code,每次请求授权页面链接,都需传入有效 code。注意:授权码有效期为 2 分钟,且使用一次后立即失效
步骤三:拼接授权页面链接
开发者获取授权码 code 后,需拼接授权页面链接,供授权用户访问,链接示例如下:
链接示例
携带参数,必须按照示例的大小写格式,加上参数后末尾一定要加上#login。
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链接地址
https://open.qly.cmviot.cn/grant请求参数
| 参数名称 | 参数类型 | 是否必需 | 参数含义 | 说明 |
|---|---|---|---|---|
| code | String | Y | 授权码 | |
| appId | String | Y | 应用 ID | |
| url | String | N | 重定向 uri | 为满足用户在两边应用的使用体验,千里眼授权 H5 支持返回三方应用。若无需返回,url 可不传。 |
url 数据模型
| 三方应用类型 | url 举例 | 说明 |
|---|---|---|
| App | url=dingtalk:// 以返回钉钉为例,完整 url 一定补齐 | 特殊字符需要转义,进行 encode |
| 网页 | url=https%3A%2F%2Fwww.baidu.com%2F | 特殊字符需要转义,进行 encode |
| 微信小程序 | 需区分本 H5 是在微信内打开,还是非微信内打开 | 特殊字符需要转义,进行 encode |
微信小程序 url 数据模型
| 访问 H5 的客户端 | 是否支持返回 | url 举例 | 说明 |
|---|---|---|---|
| 微信客户端内 | 不支持 | 不传 url 字段 | 用户本身就在微信内,可直接关闭本 H5,此时仍在小程序内,体验上跟返回一样 |
| 非微信客户端 | 支持 | weixin://dl/business/?ticket=<ticket> | 1、通过微信提供的“URL Scheme”功能生成 ticket; 2、务必在小程序后台设置中开启“允许从外部浏览器打开”; 3、兼容性上,不是所有用户都支持直接从外部浏览器打开小程序,这取决于用户的设备和微信版本 4、生成的 URL Scheme 只有 30 天有效期,请及时更新 |
- 小程序跳转,相关概念说明如下:
URL Scheme 在 H5 跳转小程序中的作用
URL Scheme 是一种特定的 URL 格式,用于在微信外部(如 H5 页面)打开小程序。它是实现 H5 跳转小程序的关键技术。实现 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 页面
拼接完整的授权页面链接后,跳转进入多企业授权 H5 页面。
每次跳转授权页面链接,都需先获取一次授权码,因授权码使用一次后立即失效,且仅 2 分钟有效,拼接好链接后,需尽快跳转入本 H5 页面。
步骤五:用户在 H5 页面进行登录/操作
用户在 H5 页面,完成企业对该应用的授权。 
步骤六:用户返回开发者应用,应用获取已获得授权的企业列表
每次用户点击过授权入口,均建议您的应用重新获取一次授权企业列表。 调用查询应用已授权企业列表接口。
步骤七:所有 API 请求,请求头需加上企业字段
多企业应用,请求所有接口时,在 header 里加上字段“region”,传入本次要查询企业的企业编码。
若不传 region 字段,默认查询绑定企业的相关数据。
所有接口,是指包括【服务端 API】全目录下的接口。