如何使用文档

更新时间:2020-03-13 10:13:56

智能人居平台的文档目的是指导用户逐步上手平台的能力,为了更好的使用文档,说明文档的结构和使用思路。

第一部分

第一部分是“智能人居开放平台”介绍,这里列出了平台的基本信息:平台介绍名词解释协同产品版本说明

平台介绍:对智能人居平台的基本介绍,基本架构和能力范围,这些信息会帮助开发者了解智能复用人居开放平台的能做到什么。
名词解释:介绍核心的“租户”概念,和控制台名词业务名词IoT名词,阅读这些信息可以更好的理解文档中出现的名词。
协同产品:介绍与智能人居开放平台相关的物联网平台生活物联网平台,介绍它们之间的关系。理解这些会帮忙开发者了解在一些特定场景下,同时使用几个平台的能力来完成业务。
版本说明:介绍智能人居开放平台的版本发布内容,帮助开发者了解最新的能力动态。

第二部分

第二部分有三个大章节:Quick Start使用指南API Reference
这部分是智能人居开放平台的核心内容,介绍如何使用平台的能力。
在使用时,可以按Quick Start -> 使用指南 -> API Reference 的顺序来阅读,在文章内容中也是这样引导的。

Quick Start
这个章节的内容都很简短,每篇文章对主题做基本的介绍,并提供到具体功能的使用指南的链接。
Quck Start中以主题的形式列出智能人居开放平台的能力范围。如果您要利用智能人居开放平台实现某些功能,先到这里查找相关的主题。这些主题包括:


使用指南
使用指南中是对功能的详细介绍,会提供控制台每个功能的说明,以及如何开发服务端移动端应用,如何接入智能语音平台使用扩展服务。在介绍业务的功能是,会提供相关服务的API链接,指向到
API Reference中的页面。


这里是对智能人居开放平台的功能最详细的说明,如果您在这里没有找到答案,或有描述不详细的内容,可以到在线支持中提交在线工单来寻求帮助。

API Reference

这里是所有使用到的API说明,分三部分:通用说明云云接口服务移动端服务。除了通用说明外,其它两部分是根据调用端的类型开区分。


智能人居开放平台的能力,大多是以云云接口服务的形式提供,所以这部分的内容比较多,分三部分:

  • 平台服务:构建平台基础能力的API定义,如账号接入、边缘网关、实人认证、组织和角色API等。
  • 基础服务:构建业务基础能力的API定义,如设备、空间、场景相关的API,这些API会用来构建ISV的业务能力。
  • 扩展服务:提供领域或方案级的扩展服务API定义,每组API都针对一个具体的领域服务。如人脸服务、车辆通行服务、门禁服务等。

第三部分

第三部分为开发过程中常见的问题提供支持和沟通渠道,包括常见问题最佳实践获得支持

常见问题:根据问题域列出了APP、账号和接口的常见问题,并在不断补充中。
最佳实践:提供具体领域或主题的最佳实践介绍;
获得支持:提供和商务、在线、技术上的支持。

results matching ""

    No results matching ""