# 统一请求地址
调用API时,请使用统一请求地址:https://www.gongyeyuniot.com/api/${FunctionURL}
需要填入的请求参数如下
参数位置 | 参数名 | 说明 | 是否必填 |
---|---|---|---|
请求头 | PubKey | 平台生成的公钥 | 是 |
请求头 | TS | 发起调用时的时间戳(单位为秒,10位纯数字字符串) | 是 |
请求头 | TTL | 签名的有效时间(单位为秒,整数类型) | 是 |
请求头 | SIG | “开始使用 (opens new window)-使用签名认证方式” 步骤3中生成的签名sig | 是 |
请求地址 | FunctionURL | 需要请求的功能路径,详见API接口文档 | 是 |
# 统一返回值
API接口会根据用户请求,返回统一格式的JSON字符串。
正常返回结果的格式如下
{
"meta": {
"success": true,
"message": "100001"
},
"data": ...
}
返回值的含义如下表所示
名称 | 含义 | 数据类型 |
---|---|---|
meta | 元数据,包含请求是否成功的标志参数 (success) ,以及异常编码或信息 (message) | object |
success | 请求是否成功 (true:成功;false:失败) | boolean |
message | 返回定义编码,可以用于判断请求是否成功,以及请求失败原因,详见API异常状态码 (opens new window) | string |
data | 返回数据,详见API接口文档 | object |