调用生活物联网平台API时,您需要了解API的公共信息,包括网关协议与地址、调用方法、请求参数、返回参数等。

调用客户端API与调用云端API需要使用不同的AppKey和AppSecret来进行身份认证和鉴权。AppKey和AppSecret由生活物联网平台颁发,获取方式如下。

  • App端:AppKey和AppSecret集成在安全图片中,您只需集成安全图片即可。详细操作请参见集成安全图片
  • 云端:您需要从平台获取AppKey和AppSecret,详细操作请参见获取云端Appkey

API网关协议与地址

当您发送请求调用API时,API网关会校验含有AppSecret的签名。如果校验不通过,则会丢弃请求并返回401错误码。其中,API网关的协议为HTTPS,网关地址如下。

数据中心 Region ID 网关地址
华东2(上海) cn-shanghai api.link.aliyun.com
新加坡 ap-southeast-1 ap-southeast-1.api-iot.aliyuncs.com
德国(法兰克福) eu-central-1 eu-central-1.api-iot.aliyuncs.com
美国(弗吉尼亚) us-east-1 us-east-1.api-iot.aliyuncs.com

如何调用API

生活物联网平台提供了App端API和云端API,并为您提供了以下语言API的调用SDK或调用示例。

端侧 支持的语言种类 调用SDK或调用示例
App端
  • Android
  • iOS
调用客户端API
云端
  • JAVA
  • PHP
  • Python
  • .NET
  • Node.js
调用云端API

如果您需要使用别的语言来调用API,则需要自行实现该语言的加签逻辑,请参见加签机制

公共请求参数

生活物联网平台提供的所有API都遵循一致的入参规范,其中如下字段为接口调用必须传入的公共字段。

参数 子参数 类型 必有 描述
id - String 请求ID,如使用生活物联网平台提供的SDK,则会自动生成;如果您自行调用API,则需要自己生成。该参数主要用于关联请求应答及问题定位。
version - String 开放平台的版本号,当前固定为1.0
request - - 系统请求参数。
- apiVer String 所调用接口对应的版本号,具体参见相应的接口文档。
- iotToken String 该参数仅调用客户端API时生效,主要用于确认请求发起者的系统参数,使用生活物联网平台提供的账号SDK时该值会自动生成。
- cloudToken String 该参数仅调用云端API时生效,需要您使用项目ID自行获取对应的Token,具体API请参见云端资源服务的获取云端资源token。
- language String 用于传递多语言信息,该参数仅调用客户端API时生效。
params - - 业务请求参数,具体内容因不同的接口而不同,部分接口可能不需要入参,仅通过默认的用户鉴权信息即可操作,具体请参见相应的接口文档。

公共返回参数

生活物联网平台提供的所有API都遵循一致的出参规范,其中如下字段为接口调用时返回的公共字段。

参数 类型 必有 描述
id String 用于识别请求记录,即对应的请求ID。
code Int 接口返回码字段,请求成功时返回200;请求失败时返回详细的错误码,错误码介绍请参见错误码字典
message String 接口返回信息字段,请求成功返回success;请求失败返回错误原因。
data - 接口返回值字段,每个接口的返回值皆可自定义(部分接口没有返回值,仅通过返回码标识请求成功或失败)。