1. 创建用户

描述

创建用户，也就是用户注册。分成多个API，如下表所示。每个API的url不同。

请求参数

[!note|name字段能干嘛?] 注册的时候，用户的name字段是自动生成的，例如生成为XdUaXduA/+86-15810419017这样用户名,此时如果有name字段，就可以优先填充name字段。

[!note|为什么注册不支持afs字段?] afs太贵了,0.002元一次。虽然比0.04元的短信费用。未来我们可以再支持afs字段。

返回参数

SDK调用

    const api_param = {
        ustr      : "+86-15810419012",
        pwd       : "a906449d5769fa7361d7ecc6aa3f6d28",
        vfcode    : "之前使用短信验证码接口获取的短信验证码",
        vfc_id    : "之前是用短信验证码接口获取的返回id字段",
        name      : "羊辣椒",
    }
    console.log(api_param);
    res = await xduaClient.tupUserr(api_param)
    console.log(res);
    if(res.error == 0){
        console.log(api_name+"成功");
    }else{
        console.log(api_name+"失败 "+res.reason);
    }

错误码

2. 创建一个虚拟用户并关注它

调用场景

• 创建一个老人用户，然后关注TA.

请求方式

POST:/caree

请求参数

返回参数

错误码

3. 微信小程序用户注册

打开微信小程序,调用wx.login()获取code,通过code到后台换的openid,拿着openid和wx.getUserProfile()获取的用户信息来平台注册。

调用场景

微信小程序只能用来在社区注册。神区只能通过电话方式注册。

请求方式

POST:/wxappuser

请求参数

参考小程序登录、用户信息相关接口调整说明

[!note|label:关于gender字段] wx.getUserProfile()获取的性别是数字, 0:未知,1:男性,2:女性。小程序要加工成地球号平台规范的性别标记。类型变为字符串。大写的"U"表示性别未知。大写的"F"表示女性Female,大写的"M"表示男性Male.

[!note] 社户创建时遵从简单第一步原则，创建只需要社户名和社户执照号两个属性就可以创建社户。剩下通过setuserr来完善。

返回参数

错误码

4. 电话号码注册

描述

以电话号码注册社区用户。

调用场景

开发者登录超级控制台后,可以以Zoon社户创建自己的社户。

请求参数

[!note] 社户创建时遵从简单第一步原则，创建只需要社户名和社户执照号两个属性就可以创建社户。剩下通过setuserr来完善。

• extra必须是合法的json字串,如果不是,服务端解析失败,会当作extra不存在.
• 如果是邮箱注册, ustr里存邮箱.

返回参数

错误码

调用SDK

    const api_param = {
        ustr      : "+86-15810419011",
        pwd       : "a906449d5769fa7361d7ecc6aa3f6d28",
        afs       : "滑动验证条获取的afs码",
        vfcode    : "通过手机验证码获取的验证码",
        vfc_id    : "发送验证码请求获取的验证码id",
        name      : "羊辣椒",
    }

    res = await xduaClient.tupUser(api_param)
    console.log(res);
    if(res.error == 0){
        console.log(api_name+"成功");
    }else{
        console.log(api_name+"失败 "+res.reason);
    }

描述

创建社户。 社户在控制台创建傀儡社户。

社户注册和添加接口包含两种字段:固定字段和额外字段。这么设计的原因是不同社户表会有不同的字段,这些字段是不可以预计的,而网关的设计不能无限制添加字段，所以要求额外的自定义字段放在extra里。

调用场景

开发者登录超级控制台后,可以以Zoon社户创建自己的社户。

配置参数

参数意义参考接口参数

请求参数

|dsn |body|string|设备序列号 |必须 | |type |body|string|android:android应用,ios:ios应用,browser:浏览器应用,pc:pc机的可执行文件exe或者standalone部署的应用|必须 | |model |body|string|设备的模型 |必须 | |man |body|string|设备生产厂商 |必选 | |os |body|String|设备操作系统 |必选 | |pkg |body|String|应用包名|必选 | |channel|body|String|渠道名 |必选 |

[!note] 社户创建时遵从简单第一步原则，创建只需要社户名和社户执照号两个属性就可以创建社户。剩下通过setuserr来完善。

• extra必须是合法的json字串,如果不是,服务端解析失败,会当作extra不存在.
• 如果是邮箱注册, ustr里存邮箱.

返回参数

错误码

5. 电话号码注册

描述

创建社户。 社户在控制台创建傀儡社户。

社户注册和添加接口包含两种字段:固定字段和额外字段。这么设计的原因是不同社户表会有不同的字段,这些字段是不可以预计的,而网关的设计不能无限制添加字段，所以要求额外的自定义字段放在extra里。

调用场景

开发者登录超级控制台后,可以以Zoon社户创建自己的社户。

配置参数

请求参数

|dsn |body|string|设备序列号 |必须 | |type |body|string|android:android应用,ios:ios应用,browser:浏览器应用,pc:pc机的可执行文件exe或者standalone部署的应用|必须 | |model |body|string|设备的模型 |必须 | |man |body|string|设备生产厂商 |必选 | |os |body|String|设备操作系统 |必选 | |pkg |body|String|应用包名|必选 | |channel|body|String|渠道名 |必选 |

[!note] 社户创建时遵从简单第一步原则，创建只需要社户名和社户执照号两个属性就可以创建社户。剩下通过setuserr来完善。

• extra必须是合法的json字串,如果不是,服务端解析失败,会当作extra不存在.
• 如果是邮箱注册, ustr里存邮箱.

返回参数

错误码

6. 删除用户

描述

删除用户。

调用场景

根用户在超级控制台登录. 它会让资源永久消失。。

配置参数

请求参数

返回参数

错误码

7. 关闭用户:DisUser

描述

关闭用户。

调用场景

神管理员登录超级控制台后,可以关闭普通开发者的用户。使得用户进入DISABLED状态，也只有Zoon角色重新打开这个用户。

管理员（Zoon）

1. 登录http://consoler.{zond_id}.xdua.com后,
2. 根据条件查询用户，条件是某个用户。
3. 点击冻结，可以关闭用户。

配置参数

请求参数

返回参数

错误码

8. 注销用户:DolUser

描述

软删用户。

调用场景

开发者登录超级控制台后,可以点击自己的用户，然后删除掉。如果哪天后悔了，可以联系Zoon来恢复。

配置参数

参数意义参考接口参数

请求参数

返回参数

错误码

9. 激活用户

描述

打开用户。

调用场景

管理员（Zoon）

1. 登录http://consolex.xdua.com后,
2. 根据条件查询用户，条件是某个被冻结的用户。
3. 点击解冻，可以解冻店铺。

配置参数

参数意义参考接口参数

请求参数

返回参数

错误码

10. 回收用户

描述

回收用户。

调用场景

管理员应开发者的要求，登录超级控制台后,查询到某个开发者下面的被删除的用户。然后回收。开发者刷新就可以看到了。为此，开发者要提供自己的uid和要回收的用户的名字。

配置参数

参数意义参考接口参数

请求参数

返回参数

错误码

11. 回收用户

描述

回收用户。

调用场景

管理员应开发者的要求，登录超级控制台后,查询到某个开发者下面的被删除的用户。然后回收。开发者刷新就可以看到了。为此，开发者要提供自己的uid和要回收的用户的名字。

配置参数

参数意义参考接口参数

请求参数

返回参数

错误码

12. 修改用户

描述

修改用户。

调用场景

开发者登录超级控制台后,可以修改自己创建的用户。修改仅仅限于可以修改的name,brief等字段。

配置参数

参数意义参考接口参数

请求参数

注:修改用户资料至少需要一个修改项。用户只能设置自己和马甲的接口.

返回参数

示例

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的用户名",
        "brief":"新的用户介绍",    
    }    
}

错误码

13. 修改用户

描述

修改用户。

调用场景

开发者登录超级控制台后,可以修改自己创建的用户。修改仅仅限于可以修改的name,brief等字段。

配置参数

参数意义参考接口参数

请求参数

注:修改用户资料至少需要一个修改项。用户只能设置自己和马甲的接口.

返回参数

示例

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的用户名",
        "brief":"新的用户介绍",    
    }    
}

错误码

14. 查询用户

描述

查询用户。

调用场景

开发者登录http://consolex.xdua.com后,可以以Zoon角色查询属于自己名下的所有用户。

配置参数

参数意义参考接口参数

URL

GET:https://api.xdua.com/user

请求参数

参考标准查询接口请求参数

返回参数

参考标准查询接口返回参数

result.list部分

result.list部分

错误码

15. 私查用户

描述

私查用户。

调用场景

开发者登录http://consolex.xdua.com后,可以以Zoon角色查询所有用户。

配置参数

参数意义参考接口参数

URL

GET:https://api.xdua.com/user

请求参数

参考标准查询接口请求参数

返回参数

参考标准查询接口返回参数

result.list部分

错误码

16. 详情用户

描述

详情用户。

调用场景

管理员登录超级控制台后,可以随意查询能看见的所有用户列表。点击其中一个用户（不管是不是自己的），就可以点击访问。

配置参数

请求参数

返回参数

[!note] 用户的使能状态,0:打开 1:关闭. 关闭的用户处于冻结状态,不接受登陆/注册所有操作.

返回示例

result部分

{
    "id":"rYub4wrT",
    "data": {


    },
}

错误码

描述

私详用户。神级用户登录后获取自己的用户资料。

调用场景

开发者登录超级控制台后,在用户列表，选择用户，点击详情，就可以查看自己的用户。GIT的默认字段和GET不一样。

配置参数

请求参数

返回参数

返回示例

result部分

{ 
    sex: 'f',
    stato: '',
    state: 0,
    pid: 'AnoNymuS',
    aid: 'SvKerneL',
    avatar:'http://avatar.xdua.com/XdUaXduA/a.jpg?x-oss-process=style/avatarp64',
    id: 'Dt5mvrtU',
    bday: 19000000,
    cstamp: '2016-09-10 11:17:53',
    name: '辣椒帅',
    role: 'root',
    zone: 'XdUaXduA',
    ustamp: '2020-04-06 16:21:01' 
}

错误码

BrowserSDK调用

const XduaClient = require('../lib')
const xduaClient = await XduaClient({
    LOGIN_TOKEN:"eyJhbGciOiJSUzI1NiIsImtpZCI6ImI1MGIxZWZmZGMwMzVlMjg2OWI2YzQ1ZjMzYmRmNWQ3In0.eyJpYXQiOjE1ODQ5NzUwNDMsIm5iZiI6MTU4NDk3NTA0MywiaXNzIjoieGR1YS5jb20iLCJleHAiOjE5MDAzMzUwNDMsImF1ZCI6IkJyb3dTZGtUIiwic3ViIjoiQW5vTnltdVMiLCJqdGkiOiIxMjM0NTY3OCIsImlwbSI6IioiLCJkdm0iOiIqIiwic2FwIjoiU3ZLZXJuZUwiLCJhcGkiOiJBZGRMb2dpbiIsImNsciI6IlgiLCJvd24iOiJEdDVtdnJ0VSIsInRpZCI6InhzQUZGNmpHIiwiYnVnIjoiREUiLCJsZ24iOiJOdWxsTnVsbCIsInR5cCI6IkwiLCJ0YWciOiJQcmltYXJ5Iiwiem9uZSI6IlhkVWFYZHVBIiwiY29ycCI6IlhkVWFYZHVBIiwic2hvcCI6IlhkVWFYZHVBIiwicm9sZSI6IioiLCJydWxlIjoiKiJ9.b_KQVug-D83hsfzHVoOvyJZUjjnWhr1UiRCLOBcUSFCLfh3ZoP5GE7m98s6H3QsDpYs20hFkFecj0xiyxzQKy5DOq9XbroXffDmBgg5y45WYnW3P8iqB2WQBtBwEU3VAWk_Vx6UwnGmpb_juu7KsFK33rWswFx3odbw7xe2iMdReywc6bYHf0P7s7kNYqYF_n-odiO6UsZd7yeNos8Hn7XtzE2igD7DhTbB0oxqEzVHoMtFcVAdstsLi3aAcJOK2Gp-XhWHSuiGqd9kTPmghk5cmIDcN7KOOZ6y1GQevM2Qc_7tfebP3Ev-bAZEPAyUA77zRrQMrpwJouejR_sNd3g",
})
let api_name = "用户登录"

let res = await xduaClient.addToginx({
    ustr:   '+86-15810419011',
    pwd :   '**************************',
    afs :   "ignore"
})
let got_user_id = "";
if(res.error == 0){
    got_user_id = res.result.user_id;
    console.log(api_name+"成功 "+got_user_id);
}else{
    got_user_id = res.result.id;
    console.log(api_name+"失败 "+res.reason);
}
//--------------------------------------------------
api_name = "私详用户";
query = {
    format:"raw",
    fields:"@all",
}
res = await xduaClient.gitUser(query)
if(res.error == 0){
    console.log(api_name+"成功");
}else{
    console.log(res)
    console.log(api_name+"失败 "+res.reason);
}

17. 下线用户

描述

下线用户。

调用场景

开发者登录超级控制台后,可以下线自己创建的用户。

配置参数

参数意义参考接口参数

请求参数

返回参数

错误码

18. 发布用户

描述

发布用户。

调用场景

开发者登录超级控制台后,可以下线/发布自己的用户。这个动作是管理员不能干涉的。

配置参数

参数意义参考接口参数

请求参数

返回参数

错误码

19. 回收用户

描述

回收用户。

调用场景

管理员应开发者的要求，登录超级控制台后,查询到某个开发者下面的被删除的用户。然后回收。开发者刷新就可以看到了。为此，开发者要提供自己的uid和要回收的用户的名字。

配置参数

参数意义参考接口参数

请求参数

返回参数

错误码