AAC OpenAPI
更新时间: 2024-12-04 15:46:14
此手册用于记录大数据开发与管理平台中,AAC产品所有对外开放的OpenAPI,阅读此手册,你将了解AAC产品开放的OpenAPI能力与调用方法。
一、EasyAAC公共参数
1.1 响应格式
名称 | 类型 | 描述 |
---|---|---|
code | Number | 响应码 |
reqId | String | 请求ID |
cost | Number | 耗时,单位:ms |
msg | String | 响应消息 |
result | Object | 响应结果 |
1.2 响应码及响应消息
1.2.1 code
系统正常码
响应码 | 说明 |
---|---|
0 | 服务器正确处理请求 |
系统异常码(小于0)
响应码 | 说明 |
---|---|
1 | 服务器错误,空指针、数组越界等非业务代码抛出异常 |
-2 | 非法请求,参数异常、参数格式错误等接口的请求非法性抛出的通用错误 |
-3 | 用户不在当前项目 |
-4 | 用户未登录(或者会话无效),且该接口需要登录 |
-5 | 加锁失败 |
-6 | 签名无效 |
-7 | 无可用项目 |
业务异常码
响应码 | 说明 |
---|---|
1000 | 服务异常 |
1001 | 未配置 email 后缀 |
1002 | 查询账号信息接口异常 |
1003 | 向控制台添加用户接口异常 |
1004 | 账号冲突,请联系技术支持 |
1005 | 账号已存在 |
1006 | 创建新账号失败 |
1.2.1 msg
响应消息 | 说明 |
---|---|
success | 查询成功 |
fail | 查询失败 |
1.3 响应实体列表
StatisticsInfo
名称 | 类型 | 描述 | 必传 | 默认值 |
---|---|---|---|---|
userNum | int | 实时在线用户数 | 是 | |
success | boolean | 业务是否成功(兼容老接口的返回值) | 是 |
二、OpenAPI列表
2.1 OpenAPI总览
模块 | 名称 | 支持版本 | 状态 | 请求方法 | 请求路径 |
---|---|---|---|---|---|
用户数查询 | 查询实时用户数 | v1.8.9.5.2 | 已上线 | GET | /user/v1/activenum/get |
账号 | 新建账号 | v1.9.0 | 待上线 | GET | /user/v1/add |
2.2 EasyAAC的Api
2.2.1 查询实时用户数
GET /user/v1/activenum/get
产品版本:v1.8.9.5.2
描述:查询实时用户数
URL参数/请求体
无
响应体
名称 | 类型 | 描述 | 必传 | 默认值 |
---|---|---|---|---|
code | Number | 状态码 | 是 | |
msg | String | 错误信息 | 是 | |
cost | Number | 接口消耗毫秒数 | 是 | |
reqId | String | 请求ID | 是 | |
result | StatisticsInfo | 统计信息 | 是 |
响应示例:
{
"code":0,
"msg":"success",
"result":
{
"userNum":198,
"success":true
},
"reqId":"d306a16961f146cc8c579b327808abf9",
"cost":1
}
2.2.2 新建账号
POST /user/v1/add
产品版本:v1.9.1
描述:提供在数开平台创建新账号功能
URL参数/请求体
名称 | 类型 | 描述 | 必传 |
---|---|---|---|
account | String | 新建账号名 | 关联邮箱客户:必不传 非关联邮箱客户:必传 |
String | 新建账号邮箱名 | 是 | |
fullName | String | 新建账号用户名 | 否 |
phone | String | 新建账号手机号 | 否 |
loginSystem | String | 新建账号的来源 | 是 |
请求示例:
{
"account":"test",
"email":"test@163.com",
"loginSystem":"o2zl"
}
响应体
名称 | 类型 | 描述 | 必传 |
---|---|---|---|
code | Number | 响应状态码 | 是 |
msg | String | 提示信息 | 是 |
cost | Number | 请求耗时,单位毫秒 | 是 |
reqId | String | 本次请求id | 是 |
result | JSON | 响应结果 | 是 |
响应示例:
{
"code": 0,
"msg": "创建成功",
"result": "{\\"account\\":\\"test\\",\\"email\\":\\"test@163.com\\",\\"loginSystem\\":\\"o2zl\\"}",
"reqId": "d609866cc922415d918a1714191de298",
"cost": 968
}