阿里云IoT提供了数量众多的API供客户端使用,为了减少客户的接入成本,将调用云端API过程进行了封装,并向客户提供了客户端SDK(分Android SDK和iOS SDK)。客户端只需要按照以下方式调用API即可。

iOS客户端如何调用云端API

参见iOSAPI通道SDK里的使用说明。

Android客户端如何调用云端API

参见AndroidAPI通道SDK里的使用方式。

通用说明

公共参数

生活物联网平台提供的所有客户端API都遵循一致的接口定义规范,其中如下字段为接口调用必须传入或一定会返回的公共字段,此处统一列出,后续接口详细文档说明中将不再单独包含该参数。

请求参数

参数 子键 类型 必有 描述
id - String 请求id,如使用生活物联网平台提供的SDK,则会自动生成;如果您自行调用API,则需要自己生成。该参数主要用于关联请求应答及问题定位
version - String 开放平台的版本号,当前固定为1.0
request - - 系统请求参数
- apiVer String 所调用接口对应的版本号,具体参见相应的接口文档
- iotToken String 请求参数,如使用生活物联网平台提供的SDK,则会自动生成;如果您自行调用API,则由您调用token接口获取。主要用于确认请求发起者的系统参数
- language String 请求多语言的参数,用于传递多语言信息(目前支持:中文 zh-CN、英文 en-US、西班牙语 es-ES、法语 fr-FR、俄语 ru-RU、德语 de-DE、日语 ja-JP、韩语 ko-KR、印地语 hi-IN、意大利语 it-IT)
params - - 业务请求参数,具体内容因不同的接口而不同,部分接口可能不需要入参,仅通过默认的用户鉴权信息即可操作,具体请参见相应的接口文档

返回参数

参数 类型 必有 描述
id String 用于识别请求记录,即对应的请求id
code Int 接口返回码字段,生活物联网平台客户端API所有接口公用。200表示请求成功;非200表示请求失败(具体失败原因请参见错误码字典
message String 接口返回信息字段,生活物联网平台客户端API所有接口公用。请求成功返回“success“,否则返回错误原因
data - 接口返回值字段,每个接口的返回值皆可自定义(部分接口没有返回值,仅通过返回码标识请求成功或失败)

网关协议与地址

  • 中国站API网关地址:https://api.link.aliyun.com
  • 国际站API网关地址:https://api-iot.ap-southeast-1.aliyuncs.com