应用 API
更新时间：2021-07-22 03:18:39下载pdf
本文介绍了应用 API 的接口。
背景信息
调用应用 API 需要对云开发项目的 API 机制有一定的了解，详见 API 使用指南。在调用过程中，可以使用 Postman 先进行接口的调试，详见 设置 postman 环境并调用 API。
接口
POST:/v1.0/data-analysis/data
参数
| 参数 | 数据类型 | 是否必填 | 说明 |
|---|---|---|---|
| apiCode | String | 必填 | 在数据分析平台创建 API 时生成的 apiCode |
| params | JSON | 必填 | 在数据分析平台创建 API时自定义的参数，json格式。详见 API 管理 |
返回值
| 参数 | 类型 | 说明 |
|---|---|---|
| result | JSON | 返回值的对象 |
result 说明
| 参数 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| errorCode | String | 接口失败时的错误码，成功时不返回该数据 |
| errorMsg | String | 接口失败时的错误信息，成功时无此字段 |
| resultDO | JSON | 返回的具体数据 |
resultDO 说明
| 参数 | 类型 | 说明 |
|---|---|---|
| data | List | 响应的具体数据，里面的格式就是您在数据分析平台创建 API 时定义的返回值格式 |
| pageNo | Integer | 当前第几页 |
| totalCount | Integer | 一共有多少条数据 |
请求示例
curl --location -g --request POST 'https://openapi.tuyacn.com/v1.0/data-analysis/data?apiCode=yourApiCodec¶ms={%22page%22:1,%22size%22:10}' \
--header 'access_token: yourToken' \
--header 'sign: yourSign' \
--header 't: 1625055947233' \
--header 'sign_method: HMAC-SHA256'
响应示例
{
"result": {
"message": "success",
"pageData": {
"data": [
],
"pageNo": 1,
"totalCount": 0
},
"success": true
},
"success": true,
"t": 1626233062210
}
常见错误码
| 错误码 | 说明 |
|---|---|
| JSON_FORMAT_ERROR | params 参数的 JSON 格式异常 |
| API_NOT_EXISTS | API 不存在 |
| PARAMS_ERROR | 参数格式异常 |
| PARAMS_IS_REQUIRE | 存在必填参数未填 |
| PARAMS_IS_NOT_IN_REQUEST | 存在不在列表里的参数 |
| PARAMS_TYPE_ERROR | 参数类型错误 |
该内容对您有帮助吗？
是意见反馈该内容对您有帮助吗？
是意见反馈
关注“涂鸦智能”
涂鸦服务尽在掌握
关注“涂鸦开发者”
获取最新涂鸦开发者信息
