【小程序】应用程序编程接口汇总——授权API、OTA API、家庭API

最新推荐文章于 2024-07-07 09:00:00 发布
最新推荐文章于 2024-07-07 09:00:00 发布
阅读量1.1k 收藏 19
点赞数 18
文章标签： javascript 前端 开发语言 App API iot 小程序
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Ms_Smart/article/details/136170246
版权
本文介绍了如何在应用中使用授权API进行权限请求，包括scope的各种权限类型以及如何查询权限状态。同时，还涵盖了DeviceKit和HomeKit中关于固件更新的相关功能，如检查更新信息、获取升级状态和引导用户升级。
摘要由CSDN通过智能技术生成

授权API

ty.authorize

权限请求方法

需引入BaseKit，且在>=1.2.10版本才可使用

参数

Object object

属性类型默认值必填说明
scopestring是scope 权限名称 举例子： scope.bluetooth 蓝牙权限 scope.writePhotosAlbum 写入相册权限 scope.userLocationBackground 后台定位权限 scope.record 麦克风权限 scope.camera 摄像头权限 scope.userLocation 低精度定位权限 scope.userPreciseLocation 高精度定位权限
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数

函数定义示例

/**
 * 权限请求方法
 */
export function authorize(params: {
  /**
   * scope 权限名称
   * 举例子：
   * scope.bluetooth 蓝牙权限
   * scope.writePhotosAlbum 写入相册权限
   * scope.userLocationBackground 后台定位权限
   * scope.record 麦克风权限
   * scope.camera 摄像头权限
   * scope.userLocation 低精度定位权限
   * scope.userPreciseLocation 高精度定位权限
   */
  scope: string;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.authorizeStatus

查询权限状态

需引入BaseKit，且在>=1.2.10版本才可使用

参数

Object object

属性类型默认值必填说明
scopestring是scope 权限名称 举例子： scope.bluetooth 蓝牙权限 scope.writePhotosAlbum 写入相册权限 scope.userLocationBackground 后台定位权限 scope.record 麦克风权限 scope.camera 摄像头权限 scope.userLocation 低精度定位权限 scope.userPreciseLocation 高精度定位权限
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数

函数定义示例

/**
 * 查询权限状态
 */
export function authorizeStatus(params: {
  /**
   * scope 权限名称
   * 举例子：
   * scope.bluetooth 蓝牙权限
   * scope.writePhotosAlbum 写入相册权限
   * scope.userLocationBackground 后台定位权限
   * scope.record 麦克风权限
   * scope.camera 摄像头权限
   * scope.userLocation 低精度定位权限
   * scope.userPreciseLocation 高精度定位权限
   */
  scope: string;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

 👉 立即开发。

OTA API 

ty.device.checkOTAUpdateInfo

检查固件升级信息

需引入DeviceKit，且在>=1.2.6版本才可使用

参数

Object object

属性类型默认值必填说明
deviceIdstring是deviceId 设备 id
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数

ty.device.checkOTAUpgradeStatus

获取设备的固件版本状态

需引入DeviceKit，且在>=2.2.0版本才可使用

参数

Object object

属性类型默认值必填说明
deviceIdstring是deviceId 设备 id
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性类型说明
statusnumberstatus 设备的固件版本状态 0 已是最新版本、1 有待升级的固件、2 正在升级

object.fail 回调参数

参数

Object res

属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

ty.device.openOTAUpgrade

跳转设备升级页面

需引入DeviceKit，且在>=2.2.0版本才可使用

参数

Object object

属性类型默认值必填说明
deviceIdstring是deviceId 设备 id
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数

 👉 立即开发。

家庭API 

ty.home.getCurrentHomeInfo

获取当前家庭信息

需引入HomeKit，且在>=3.0.1版本才可使用

请求参数

Object object

属性类型默认值必填说明
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数

返回结果

  • success
属性类型说明
homeNamestring家庭名称
homeIdstring家庭 id
longitudestring经度
latitudestring维度
addressstring详细地址
adminboolean是否是管理员 true 是管理员; false 非管理员
  • fail
属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

请求示例

ty.home.getCurrentHomeInfo({
  success: (res) => {
    console.log(res);
  },
  fail: (error) => {
    console.log(error);
  }
})

返回示例

{
  "homeId": "26725023",
  "admin": true,
  "latitude": "30.30039978027344",
  "longitude": "120.0689010620117",
  "homeName": "我的家庭",
  "address": "华策中心A座"
}

ty.home.getDeviceIdList

获取当前维度下的设备 id 列表

需引入HomeKit，且在>=3.1.0版本才可使用

请求参数

Object object

属性类型默认值必填说明
ownerIdnumber是维度 id（比如家庭id）
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数

返回结果

  • success
属性类型说明
devIdsArray<String>设备 id 列表
  • fail
属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

请求示例

ty.home.getDeviceIdList({
  ownerId: '26725023',
  success: (res) => {
    console.log(res);
  },
  fail: (error) => {
    console.log(error);
  }
})

返回示例

{
  "devIds": [
    "vdevo168845027498793", 
    "64710761ecfabcaaf553", 
    "6c87332fc414a65029ovfr"
  ]
}

ty.home.getRoomList

从 sdk 本地缓存中获取当前家庭维度下房间的设备 id 列表

需引入HomeKit，且在>=3.1.0版本才可使用

请求参数

Object object

属性类型默认值必填说明
ownerIdnumber是维度 id（比如家庭 id）
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数

返回结果

  • success
属性类型说明
roomDatasArray<RoomInfo>房间列表

RoomInfo

属性类型说明
nameString房间名称
roomIdnumber房间 id
deviceIdsArray<String>设备 id 列表
  • fail
属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

请求示例

ty.home.getRoomList({
  ownerId: '26725023',
  success: (res) => {
    console.log(res);
  },
  fail: (error) => {
    console.log(error);
  }
})

返回示例

{
  "roomDatas": [{
    "name": "Living room",
    "deviceIds": ["vdevo160395678273817"],
    "roomId": 18585095
  }, {
    "name": "Master bedroom",
    "deviceIds": ["64710761ecfabcaaf553"],
    "roomId": 18585096
  }, {
    "name": "Second bedroom",
    "deviceIds": [],
    "roomId": 18585097
  }]
}

ty.home.getDeviceRoomInfo

获取设备房间信息

需引入HomeKit，且在>=3.0.1版本才可使用

请求参数

Object object

属性类型默认值必填说明
deviceIdstring是设备 id
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数

返回结果

  • success
属性类型说明
roomIdnumberThe room ID.
namestringThe room name.
  • fail
属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

请求示例

ty.home.getDeviceRoomInfo({
  deviceId: '64710761ecfabcaaf553',
  success: (res) => {
    console.log(res);
  },
  fail: (error) => {
    console.log(error);
  }
})

返回示例

{
  "name": "Living room",
  "roomId": 18585096
}

 👉 立即开发。

IoT砖家涂拉拉
关注
  • 18
    点赞
  • 踩
  • 19
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
杰理AC系列OTA库的开发说明_小程序v1.0.01
08-03
【杰理AC系列OTA库开发说明】\n\n杰理AC系列OTA（Over-the-Air）库是专为小程序设计的，用于实现设备的远程固件更新功能。这个库基于小程序的RCSP（Remote Control Service Protocol）库，因此包含了众多RCSP接口，...
接口自动化 --- 授权、鉴权 以及实例说明
Monkey__yuan的博客
05-19 2305
一、 接口授权，鉴权相关概念 什么是授权，什么是鉴权 授权： 相当于给一个通行证，由服务器下发 鉴权： 鉴定是否有权限访问（判断有没有通行证） 目前最常用三种认证机制 1） Cookies 2) Session 3） token 二、 实例说明： 接口文档说明 2 实现思路： i) 登录接口：成功登录后获取响应体中的token信息 ii ) 其他接口（请求头Authorization 需要token信息），需要将token信息拼接进请求头中 代码实现示例 1） 登录接口
【后端-接口设计】java应用接口授权鉴权与URL防篡改详细设计
Ric的博客
10-13 3222
1. 颁发授权码 系统内部维护一系列授权码，授权码绑定接口白名单，第三方系统调用时需要`header`携带拥有权限的授权码才能访问指定某些接口。 2. 使用`MD5`签名防止`URL`被篡改 第三方客户端发起请求时对`URL`进行`MD5`加密，把签名放到请求头。系统做拦截，再次对`URL`进行MD5加密，做签名对比，签名一致即可放行。
前端工程师通过开发小程序利用蓝牙升级硬件固件
weixin_41850878的博客
07-07 1089
开发蓝牙小程序，尤其是针对前端开发者，主要涉及的是如何在微信小程序、支付宝小程序或是其他平台的小程序中使用蓝牙功能。以下是一些关键点和步骤：记住，不同平台（如微信、支付宝）的小程序API可能会有细微差别，因此在开发时要仔细阅读官方文档。：首先，你需要安装并配置好对应平台的小程序开发工具，比如微信开发者工具。：在小程序中使用蓝牙功能，需要在app.json：小程序提供了蓝牙相关的API，包括扫描设备、连接设备、读写数据等。：对于蓝牙连接状态的改变，小程序也提供了监听接口，如。
JAVA开发（外部接口调用授权问题记录总结）
JAVA领域优质创作者，基于分片网络查询方法专利发明者。
06-28 3522
现在很多web项目或者小程序在上线后都需要进行交叉引流，交叉业务合作，数据传输，与其他的企业，网站，app合作。那么就需要接口数据调用。那么在做外部系统接口调用和自己开发的微服务间的接口调用显然是不同的，最明显的特征就是，系统与系统间的调用首先需要授权。意思就是首先需要登录。如果没有授权的接口调用，显然所有信息都已经暴露在互联网环境下。第二就是传输数据需要加解密；如果没有加密，通过抓包也是可以看到系统间传输了什么信息。所以一般在做一些外部接口调用时，都会涉及到这两部分的内容，但是很多系统的授权和加解密方式却
【认证鉴权OAuth】1. OAuth接口访问的授权的四种方式
ladymorgana的博客
02-20 388
OAuth接口访问的授权的四种方式
2 . 8 接口自动化 --- 授权、鉴权 以及实例说明
Following my own heart
08-25 1036
一、 接口授权，鉴权相关概念 1. 什么是授权，什么是鉴权 授权： 相当于给一个通行证，由服务器下发 鉴权： 鉴定是否有权限访问（判断有没有通行证） 2. 目前最常用三种认证机制 ...
社交电商小程序源码，前后端分类，全开源
最新发布
07-08
———————— 团购 相较于直接购买，以一个更优惠的价格吸引用户带动用户，完成商品的团购。 ———————— 砍价 用户熟悉的裂变玩法，引爆社群、朋友圈、迅速裂变，低成本获客利器。 ———————— 发券...
微信小程序升级STM32 APP
10-09
微信小程序与STM32应用程序的集成，特别是在实现远程升级（OTA，Over-the-Air Update）功能上，是一项结合了移动互联网技术与嵌入式硬件开发的重要应用。STM32是意法半导体公司推出的基于ARM Cortex-M内核的微控制器...
J2ME_API.rar_J2ME_API
09-22
这个名为“J2ME_API.rar”的压缩包包含了J2ME的API文档，为开发者提供了详细的技术参考，便于理解和使用J2ME进行应用程序开发。 **J2ME架构** J2ME由配置（Configurations）和 profiles（Profiles）组成。配置定义...
NXP将推出MIFARE4Mobile应用编程接口规范
11-15
NXP推出的MIFARE4Mobile应用编程接口规范（APIs）是针对NFC（近场通信）手机上基于MIFARE技术的应用而设计的一套标准。这一规范的主要目的是简化和标准化手机网络运营商和服务供应商在NFC手机上开发和管理MIFARE应用...
小程序_OTA升级的一些情况说明
随风潜入夜，不白头
10-02 1850
由于蓝牙设备产品已经成型，不可能再将产品中的蓝牙设备拆开来拿去烧录升级，所以只能通过小程序蓝牙连接设备再进行OTA升级
微信小程序 蓝牙固件升级
hekejin的博客
03-27 6291
通过小程序连接蓝牙设备后，需要对设备进行固件升级 一、获取蓝牙设备固件的Version，进行对比 wx.writeBLECharacteristicValue({ deviceId: deviceId,//IOS中为DeviceId，Android中为Mac地址 serviceId: serviceId,//服务ID，这里针对的是只进行升级时候的端口，如F000FFC0-X...
微信小程序——后台交互个人中心授权登录
m0_74934282的博客
10-23 269
在实现授权登录的过程中，可以通过调用微信小程序的API获取用户的基本信息和权限。值得注意的是，在开发过程中，需要进行相应的数据保护，避免用户敏感信息的泄露和滥用，提升用户的信息安全保障。同时，还需遵循微信官方的开发规范和最佳实践。文件中进行配置后台的数据库及微信小程序的AppID(微信小程序ID)及AppSecret(微信小程序密钥)，来访问微信的接口服务。method1获取用户的信息存在一定的风险，所以我们要把它的方法改成false。在后台编写的控制器，来进行出来前端的请求及数据处理并且反馈带前端。
oauth2 授权码模式 流程说明和接口整理
芸中的阳光
02-19 2464
该接口对应图中，A系统访问B系统，传递clientId，clientSecret，code，redirectUri等参数换取B系统的accessToken和refreshToken。假设有这样一个场景：现有A系统和B系统，A系统想要使用B系统的账号来做三方登录，那么A系统就必须要获取B系统的授权，以便拿到B系统的用户信息。该接口会重定向到授权页面，同样，oauth2的授权界面很难满足实际使用场景，可以通过配置替换为自定义的授权页面。该接口对应上图的第一步，即传递参数，获取B系统的登录界面。
SpringBoot整合Oauth2开放平台接口授权案例
hq.zheng的博客
03-28 1329
五、修改授权中心改成动态数据库查询的方式。检查数据库发现测试商户已经导入到数据库了。四、授权中心和受保护应用端联合测试。三、受保护应用端案例代码。启动类开启Oauth2。再用token访问资源。二、授权中心案例代码。
微信小程序控制硬件第17篇 : 腾讯连连小程序通过LLSync蓝牙协议控制安信可PB-02模组，无需网络实现蓝牙本地通讯。（附带源码）
徐宏的博客 | 修身齐家治国平天下
02-07 4492
文章目录前言一、注册腾讯物联开发平台设备新建项目新建产品创建数据模板选择设备开发方式交互开发配置新建设备二、设备端操作硬件简介与连接准备软件环境工程目录烧录步骤三、腾讯连连小程序调试本人开源微信物联网控制一览表另外，不要把我的博客作为学习标准，我的只是笔记，难有疏忽之处，如果有，请指出来，也欢迎留言哈！       微信物联网生态主要分在微信硬件开发平台与腾讯物联开发平台，前者已经停止维护，但依然有着很大的学习价值，而后者作为主推的平台，集成很多功能，包括从微信小程序实现配网到
微信小程序摄像头授权，及避免多次点击触发
Ronion123的博客
01-15 1985
3.用户不同意弹出小程序设置页面，可以让用户自行开启需要的权限。5.用户拒绝授权无法使用摄像头，用户扫描失败弹出扫描失败窗口。1.在用户要使用到摄像头时调用摄像头接口。4.用户点击前往设置自行开启。2.用户同意即可使用。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

IoT砖家涂拉拉

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值