所有的/v1打头的接口,都要传一个token作为校验信息,放到header里,header key是:x-srv-token

发送邮件

  1. GET /v1/rdb/sender/mail
  2. Header: x-srv-token
  3. Payload:
  4. {
  5. "tos": ["邮箱地址1", "邮箱地址2"],
  6. "subject": "邮件标题",
  7. "content": "邮件内容,HTML格式的"
  8. }

发送短信

  1. GET /v1/rdb/sender/sms
  2. Header: x-srv-token
  3. Payload:
  4. {
  5. "tos": ["手机号1", "手机号2"],
  6. "content": "短信内容"
  7. }

发送语音

  1. GET /v1/rdb/sender/voice
  2. Header: x-srv-token
  3. Payload:
  4. {
  5. "tos": ["手机号1", "手机号2"],
  6. "content": "语音内容"
  7. }

发送IM消息

  1. GET /v1/rdb/sender/im
  2. Header: x-srv-token
  3. Payload:
  4. {
  5. "tos": ["im唯一标识1", "im唯一标识2"],
  6. "content": "消息内容"
  7. }

根据用户UUID获取用户信息

  1. GET /v1/rdb/get-users-by-uuids
  2. Header: x-srv-token
  3. QueryString: uuids=<uuid>,<uuid>,<uuid>
  4. Resp:
  5. {
  6. "dat": [
  7. {
  8. "id": 33,
  9. "uuid": "zzz",
  10. "avatar": "url",
  11. "username": "zhangsan",
  12. "dispname": "张三",
  13. "phone": "",
  14. "email": "",
  15. "im": "",
  16. "is_root": 1,
  17. "leader_id": 0,
  18. "leader_name": ""
  19. }
  20. ],
  21. "err": ""
  22. }

根据用户用户名获取用户信息

  1. GET /v1/rdb/get-users-by-names
  2. Header: x-srv-token
  3. QueryString: names=<name>,<name>,<name>
  4. Resp:
  5. {
  6. "dat": [
  7. {
  8. "id": 33,
  9. "uuid": "zzz",
  10. "avatar": "url",
  11. "username": "zhangsan",
  12. "dispname": "张三",
  13. "phone": "",
  14. "email": "",
  15. "im": "",
  16. "is_root": 1,
  17. "leader_id": 0,
  18. "leader_name": ""
  19. }
  20. ],
  21. "err": ""
  22. }

查询用户是否有权限操作某个页面的资源

  1. GET /v1/rdb/can-do-global-op
  2. Header: x-srv-token
  3. QueryString: username=<username>&op=<op>
  4. Resp:
  5. {
  6. "dat": true,
  7. "err": ""
  8. }

查询用户是否有权限操作某个项目的资源

  1. GET /v1/rdb/can-do-node-op
  2. Header: x-srv-token
  3. QueryString: nid=<pid>&username=<username>&op=<op>
  4. Resp:
  5. {
  6. "dat": true,
  7. "err": ""
  8. }

批量查询用户是否有权限操作项目的资源

  1. GET /v1/rdb/can-do-node-ops
  2. Header: x-srv-token
  3. QueryString: nid=1&username=<username>&ops=<op>,<op>
  4. Resp:
  5. {
  6. "dat": [
  7. {
  8. "pid": 1,
  9. "username": "qin",
  10. "op": "note_delete",
  11. "can": true
  12. },
  13. {
  14. "pid": 2,
  15. "username": "root",
  16. "op": "note_create",
  17. "can": true
  18. }
  19. ],
  20. "err": ""
  21. }

查询租户 or 项目列表

  1. GET /api/rdb/nodes
  2. Header: X-User-Token 从个人设置中获取
  3. QueryString: cate=<cate>
  4. <cate> 可以为 tenant, project
  5. Resp:
  6. {
  7. "dat": [
  8. {
  9. "id": 9,
  10. "pid": 0,
  11. "ident": "testTenant",
  12. "name": "testTenant",
  13. "note": "xxx",
  14. "path": "testTenant",
  15. "leaf": 0,
  16. "cate": "tenant",
  17. "icon_color": "#de83cb",
  18. "icon_char": "T",
  19. "proxy": 0,
  20. "creator": "root",
  21. "last_updated": "2020-08-31T20:18:17+08:00",
  22. "admins": null
  23. }
  24. ],
  25. "err": ""
  26. }