1. 查询用息

获取某用户的所有用息列表

GET:http://api.xdua.com/uinf
字段名 位置 类型 字段说明 举例 可选
apiv head string API版本(默认是1.0.0) 1.0.0 可选
Authorization head string 客户端保存的鉴权token Authorization字符串 必选
filter query string 完全兼容mongo的查询条件 支持 类似find({'name': {'$regex':'.s.'} })的正则表达式查询 可选
page query int 搜索页号 page出现的时侯,忽略offset和limit一起表达第page页,有limit条记录 可选
offset query int 搜索开始的偏移条件 获取用用息的开始个数，不设置默认为0 可选
limit query int 搜索数量 获取用用息的数量，不设置默认为20 可选
order query string 顺序 必须按照"字段:ASC/DESC"方式书写，如 key:DESC 可选

用息查询只支持查询对本uid下的用息。

为了避免fiter的json结构字符串放到url会导致url难看，建议做成BASE64编码。filter代码的python3处理如下代码所示

import base64
encode_str = base64.b64encode("hello".encode("utf-8"))
print(encode_str)
#b'aGVsbG8='
decode_str = base64.b64decode("aGVsbG8=")
print(decode_str)
#b'hello'

返回数据

成功返回

{
    "error": 0,
    "reason": "Success",
    "result": {
        "maxpage": 1,
        "list": [{
            "enabled": "1",
            "invite_only": "0",
            "rolec": "1",
            "usroc": "0",
            "code": "children",
            "avatar": "http://xdua-files.oss-cn-qingdao.aliyuncs.com/Image/default.png",
            "creator_id": "Dt5mvrtU",
            "private": "0",
            "id": "b15f96dd",
            "cstamp": "2018-05-25 14:54:39",
            "name": "儿研所",
            "creator_name": "dua:辣椒帅",
            "brief": "给儿研所项目创建的用用息"
        }, {
            "enabled": "1",
            "invite_only": "0",
            "rolec": "2",
            "usroc": "0",
            "code": "wikicivi",
            "avatar": "http://xdua-files.oss-cn-qingdao.aliyuncs.com/Image/default.png",
            "creator_id": "Dt5mvrtU",
            "private": "0",
            "id": "83b1d782",
            "cstamp": "2018-03-25 17:42:49",
            "name": "无人阅读",
            "creator_name": "dua:辣椒帅",
            "brief": "wikcivi用用息的根用户"
        }, {
            "enabled": "1",
            "invite_only": "0",
            "rolec": "0",
            "usroc": "0",
            "code": "calathus",
            "avatar": "http://xdua-files.oss-cn-qingdao.aliyuncs.com/Image/default.png",
            "creator_id": "Dt5mvrtU",
            "private": "0",
            "id": "c0d8f537",
            "cstamp": "2018-03-25 17:50:05",
            "name": "水果篮",
            "creator_name": "dua:辣椒帅",
            "brief": "faf"
        }, {
            "enabled": "0",
            "invite_only": "0",
            "rolec": "1",
            "usroc": "0",
            "code": "test",
            "avatar": "",
            "creator_id": "Dt5mvrtU",
            "private": "0",
            "id": "fbe261e0",
            "cstamp": "2018-05-27 10:33:51",
            "name": "测试",
            "creator_name": "dua:辣椒帅",
            "brief": "测试"
        }]
    },
}
字段名 字段类型 字段说明
id string 用息的id
uid string 用息的键名，小于等于128位的字符串
* * 其它各种字段
ct int 创建的时间戳
ut int 更新的时间戳

失败返回

{
    "error": >0,
    "reason": "失败原因",
    "result": {"失败返回的参考数据"},
}

1.1. 错误码

错误码来自于error字段

通用错误码参考
用息错误码参考

1.2. Browser SDK调用示例代码

    const dua = await lovearth({
        APP_KEY: "您的appkey",
        APP_SECRET: "您的appsecret",
    })
    api_name = "添加用息";
    res = await dua.qryUinf('正则表达式表达的uid查询字符串')
    console.log(res);
    if(res.error == 0){
        console.log(api_name+"成功");
    }else{
        console.log(api_name+"失败 "+res.reason);
    }

results matching ""

    No results matching ""