提供一组基础能力的接口服务,通过这些接口可以方便的测试调用方与云端的连通性,以及接口调用方式是否正确。

通用说明

公共参数

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

请求参数

参数 子键 类型 必有 描述
id Long 请求id,如使用生活物联网平台提供的SDK,则会自动生成,如果用户自行调用API,由需要由用户自己生成;主要用于请求关联及问题定位
version String 开放平台版本号,当前固定为1.0
request 系统请求参数
apiVer String 所调用接口对应的版本号,具体参考对应接口的文档
params 业务请求参数;具体内容因不同的接口而不同,部分接口可能不需要入参,仅通过默认的用户鉴权信息即可操作,请请参考具体的接口文档

返回参数

参数 类型 必有 描述
code Int 接口返回码字段,生活物联网平台客户端API所有接口公用;200表示请求成功,非200表示请求失败(具体失败原因请参考错误码文档)
message String 接口返回信息字段,生活物联网平台客户端API所有接口公用
data 接口返回值字段,每个接口的返回值皆有各自定义(部分接口可能没有返回值,仅通过返回码标志请求成功或失败)

网关协议与地址

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

撞墙测试接口

定义描述

path 版本 描述 是否需要用户身份的鉴权
/kit/debug/ping 1.0.0 通过该撞墙测试接口,测试云端接口调用的连通性

请求参数

参数 类型 必填 描述
input String 撞墙数据

返回参数

参数 类型 必有 描述
data String 与入参的input参数传入的数据一致

示例

  • 请求示例
    {
        "id": "1509086454180", 
        "version": "1.0", 
        "request": {
            "apiVer": "1.0.0" 
        },
        // 以上为生活物联网平台客户端API请求的公共参数
        "params": {
            // 以下为该接口的业务参数
            "input" : "hello"
        }
    }
                
  • 正常返回示例
    {
        "code": 200, 
        "message": "success", 
        "data": "hello" 
    }