云开发快速入门

更新时间:2023-07-06 06:05:05下载pdf

基于涂鸦云开发丰富的基础服务、行业服务和 PaaS 服务,开发者可以低代码快速实现各类行业 SaaS。

您现在正在阅览的,是一篇不完全公开的文档,这表示该文档内容的适用性有一定的限制,文档或目录所描述的内容适用于旧版本 SDK、API、工具、平台等。
如果您需要更准确的技术文档,请访问 涂鸦 IoT 开发平台,然后自行搜索。

本文主要介绍调用基础服务 API 控制设备的流程,完整的操作实践请参见 最佳实践

开发流程

云开发快速入门

开发过程

步骤一:创建云开发项目

项目是 IoT 开发平台资源的集合,不同云开发项目之间的资源相互隔离。当前支持创建 自定义开发全屋智能 PaaS 两种项目。

说明: 创建项目时,优先推荐您选择自定义开发开发方式。开发方式区别详细介绍参见 开发方式。项目创建详细步骤参见 项目管理

云开发快速入门

步骤二:快速配置引导

项目基础信息配置完成后,会进入快速配置引导界面。

  1. 批量授权 API 产品。
    平台根据开发方式默认为项目选择部分 API 产品,开发者可以在快速配置过程中根据业务需求进行增减,或者选择其他的 API 产品。不同开发方式默认选择的 API 产品如下。

    说明: 默认选择但未开通的 API 产品,平台将自动为您开通并授权给此项目。

    • 自定义开发:
      • 授权管理
      • 行业通用设备注册
      • 行业通用设备管理
      • 行业通用设备状态查询
      • 行业通用设备控制
      • 行业通用用户管理
      • 行业通用资产管理
    • 全屋智能 PaaS:
      • 授权管理
      • 全屋智能设备管理
      • 全屋智能家庭管理
      • 全屋智能场景联动
      • IoT 数据分析
    云开发快速入门
  2. 快速创建资产并为指定用户授权。

    说明:自定义开发 开发方式需要此步骤,选择 全屋智能 PaaS 开发方式无需此操作。

    云开发快速入门

步骤三:关联设备

自定义开发全屋智能 PaaS 两种开发方式中关联设备的步骤略有不同,详细差异请查看 开发方式

自定义开发

自定义开发关联设备的流程如下,具体操作步骤参见对应的说明文档。

  1. 授权应用
    您可以在一个云开发项目下创建多个应用,为每个应用分配独立的项目资源(例如资产、用户、API 产品等),构建多端应用体系。

    云开发快速入门
  2. 创建用户
    在项目中添加用户后,才能为用户授予对应的资产管理权限。

    云开发快速入门
  3. 创建资产
    云开发支持以资产为维度,对不同资产 ID 下的设备进行权限分隔和统一管理。

    云开发快速入门
  4. 授权用户资产权限
    授予用户资产的管理员权限后,即可对资产下设备完成添加、删除和转移等操作。

  5. 添加设备
    完成资产创建后,支持通过小程序配网等方式关联设备,并支持设备在资产间的转移以及设备的解绑。

    云开发快速入门

全屋智能 PaaS

完成项目创建后,您需要将设备关联至您的项目。

说明:支持多种关联设备方式,具体参见关联设备

云开发快速入门

步骤四:配置 API 服务

您可以为云开发项目申请 API 服务(云产品)调用权限以及开通消息订阅功能。

  • 开通 API 服务
    支持两种登录 API 开通页面的方法。

    说明:API 服务开通详细步骤参见管理我的服务

    • 我的服务 中,申请需要开通的 API 服务

      云开发快速入门
    • 我的云项目> 服务 API > 新增 API服务 授权,选择目标 API 服务点击 去开通,跳转至 API 服务开通页面。

      云开发快速入门
  • API 服务授权

    API 服务开通后,还需要授权给具体项目。完成后,该项目下的授权密钥才能调用此 API。

    云开发快速入门
  • 批量授权已开通 API 服务
    在项目的 API 界面,支持查看该项目已开通的 API 产品,也可以通过 新增 API 授权 批量添加 API 产品。

    云开发快速入门
  • 开通消息订阅功能

    您可以在消息订阅模块中,开通消息订阅服务,并配置消息订阅参数,获得消息堆积的报警。

    说明:操作步骤参见 管理消息订阅

    云开发快速入门

步骤五:开发&调用

在开通 API 产品并授权给项目后,您可以使用云开发自带的 API 调试工具进行 API 调用调试。详见操作步骤参见 API 调试

步骤六:查看数据统计

您可以在 涂鸦 IoT 平台 > 云开发> 数据统计中查看您的数据统计,查看方法参见 数据统计。涂鸦提供两种维度的数据统计展示。

  • API 请求统计
  • 消息订阅统计
云开发快速入门