所有的/v1打头的接口,都要传一个token作为校验信息,放到header里,header key是:x-srv-token
发送邮件
GET /v1/rdb/sender/mail
Header: x-srv-token
Payload:
{
"tos": ["邮箱地址1", "邮箱地址2"],
"subject": "邮件标题",
"content": "邮件内容,HTML格式的"
}
发送短信
GET /v1/rdb/sender/sms
Header: x-srv-token
Payload:
{
"tos": ["手机号1", "手机号2"],
"content": "短信内容"
}
发送语音
GET /v1/rdb/sender/voice
Header: x-srv-token
Payload:
{
"tos": ["手机号1", "手机号2"],
"content": "语音内容"
}
发送IM消息
GET /v1/rdb/sender/im
Header: x-srv-token
Payload:
{
"tos": ["im唯一标识1", "im唯一标识2"],
"content": "消息内容"
}
根据用户UUID获取用户信息
GET /v1/rdb/get-users-by-uuids
Header: x-srv-token
QueryString: uuids=<uuid>,<uuid>,<uuid>
Resp:
{
"dat": [
{
"id": 33,
"uuid": "zzz",
"avatar": "url",
"username": "zhangsan",
"dispname": "张三",
"phone": "",
"email": "",
"im": "",
"is_root": 1,
"leader_id": 0,
"leader_name": ""
}
],
"err": ""
}
根据用户用户名获取用户信息
GET /v1/rdb/get-users-by-names
Header: x-srv-token
QueryString: names=<name>,<name>,<name>
Resp:
{
"dat": [
{
"id": 33,
"uuid": "zzz",
"avatar": "url",
"username": "zhangsan",
"dispname": "张三",
"phone": "",
"email": "",
"im": "",
"is_root": 1,
"leader_id": 0,
"leader_name": ""
}
],
"err": ""
}
查询用户是否有权限操作某个页面的资源
GET /v1/rdb/can-do-global-op
Header: x-srv-token
QueryString: username=<username>&op=<op>
Resp:
{
"dat": true,
"err": ""
}
查询用户是否有权限操作某个项目的资源
GET /v1/rdb/can-do-node-op
Header: x-srv-token
QueryString: nid=<pid>&username=<username>&op=<op>
Resp:
{
"dat": true,
"err": ""
}
批量查询用户是否有权限操作项目的资源
GET /v1/rdb/can-do-node-ops
Header: x-srv-token
QueryString: nid=1&username=<username>&ops=<op>,<op>
Resp:
{
"dat": [
{
"pid": 1,
"username": "qin",
"op": "note_delete",
"can": true
},
{
"pid": 2,
"username": "root",
"op": "note_create",
"can": true
}
],
"err": ""
}
查询租户 or 项目列表
GET /api/rdb/nodes
Header: X-User-Token 从个人设置中获取
QueryString: cate=<cate>
<cate> 可以为 tenant, project
Resp:
{
"dat": [
{
"id": 9,
"pid": 0,
"ident": "testTenant",
"name": "testTenant",
"note": "xxx",
"path": "testTenant",
"leaf": 0,
"cate": "tenant",
"icon_color": "#de83cb",
"icon_char": "T",
"proxy": 0,
"creator": "root",
"last_updated": "2020-08-31T20:18:17+08:00",
"admins": null
}
],
"err": ""
}