描述

发起一次登录。登录包含如下几个接口，分别用于不同的环境下。

接口名称 登录的目标网站 描述
AddLogin 任何网站 通用调用方式
AddLoginx console.xdua.com 管理地球号所有资源。可以以任意方式登录。
AddLoginr admin.app.com 某个应用的管理平台，可以以任意方式登录。
AddToginx console.xdua.com 使用电话号码登录console.xdua.com
AddMoginx console.xdua.com 使用邮箱地址登录console.xdua.com
AddNoginx console.xdua.com 使用用户名登录console.xdua.com
AddWoginx console.xdua.com 使用微信扫码登录console.xdua.com
AddToginr admin.app.com 使用电话登录admin.app.com
AddMoginr admin.app.com 使用邮箱登录admin.app.com
AddNoginr admin.app.com 使用户名登录admin.app.com
AddWoginr admin.app.com 使用微信扫码登录admin.app.com,登录方式为微信网页二维码扫描
AddAoginr admin.app.com 使用微信小程序的wx.login()获取的code判断用户存不存在

[!NOTE] admin.app.com表示地球号支持的社区级应用网站后台（例如 admin.manhu.cn就是慢护通养老管理平台。）。

配置参数

参数意义参考接口参数

请求参数

AddLogin

名称 位置 类型 必填 默认值 示例 说明
by body String 是 "tel"/"mail" 必选
ustr body String 是 电话格式是+86-15810419011/邮箱格式是:jiaoshuai@ict.ac.cn 必选
pwd body String 是 密码,32位md5码 必选
shop body String 否 店铺 必选
role body String 否 角色,默认"none" 可选
afs body String 是 人机验证码 必选

AddLoginx

名称 位置 类型 必填 默认值 示例 说明
by body String 是 "tel"/"mail" 必选
ustr body String 是 电话格式是+86-15810419011/邮箱格式是:jiaoshuai@ict.ac.cn 必选
pwd body String 是 密码,32位md5码 必选
afs body String 是 人机验证码 必选

AddToginx

名称 位置 类型 必填 默认值 示例 说明
ustr body String 是 电话格式是+86-15810419011/邮箱格式是:jiaoshuai@ict.ac.cn 必选
pwd body String 是 密码,32位md5码 必选
afs body String 是 人机验证码 必选

AddMoginx

名称 位置 类型 必填 默认值 示例 说明
ustr body String 是 邮箱格式是:jiaoshuai@ict.ac.cn 必选
pwd body String 是 密码,32位md5码 必选
afs body String 是 人机验证码 必选

AddNoginx

名称 位置 类型 必填 默认值 示例 说明
ustr body String 是 用户名字符串 必选
pwd body String 是 密码,32位md5码 必选
afs body String 是 人机验证码 必选

AddLoginr

名称 位置 类型 必填 默认值 示例 说明
by body String 是 "tel"/"mail" 必选
ustr body String 是 电话格式是+86-15810419011/邮箱格式是:jiaoshuai@ict.ac.cn 必选
pwd body String 是 密码,32位md5码 必选
role body String 否 角色,默认"none" 可选
afs body String 是 人机验证码 必选

AddToginr

名称 位置 类型 必填 默认值 示例 说明
ustr body String 是 电话格式是+86-15810419011/邮箱格式是:jiaoshuai@ict.ac.cn 必选
pwd body String 是 密码,32位md5码 必选
role body String 否 角色,默认"none" 可选
afs body String 是 人机验证码 必选

AddMoginr

名称 位置 类型 必填 默认值 示例 说明
ustr body String 是 邮箱格式是:jiaoshuai@ict.ac.cn 必选
pwd body String 是 密码,32位md5码 必选
role body String 否 角色,默认"none" 可选
afs body String 是 人机验证码 必选

AddNoginr

名称 位置 类型 必填 默认值 示例 说明
ustr body String 是 用户名字符串 必选
pwd body String 是 密码,32位md5码 必选
role body String 否 角色,默认"none" 可选
afs body String 是 人机验证码 必选

AddAoginr

名称 位置 类型 必填 默认值 示例 说明
ustr body String 是 微信小程序:wx.login()获取的code.

返回参数

公共的返回参数参考页面

{
    status: 200,
    apid: 'F0B8FF02-B970-4DA3-9ED2-8543A84EB474',
    apis: 'AddToginx',
    error: 0,
    reason: 'success',
    message: 'Success.',
    result: {
        id: 'Dt5mvrtU',
        token: 'eyJhbGciOiJSUzI1NiIsImtpZCI6ImI1MGIxZWZmZGMwMzVlMjg2OWI2YzQ1ZjMzYmRmNWQ3In0.eyJpYXQiOjE2MDY3MDI1NDksIm5iZiI6MTYwNjcwMjU0OSwiaXNzIjoieGR1YS5jb20iLCJleHAiOjE2MDY3MDMxNDksImF1ZCI6IkJyb3dTZGtUIiwic3ViIjoiRHQ1bXZydFUiLCJqdGkiOiIxMjM0NTY3OCIsInR5cCI6IlUiLCJ0YWciOiJQcmltYXJ5IiwiY2xyIjoiWCIsImlwbSI6IioiLCJkdm0iOiIqIiwib3duIjoiRHQ1bXZydFUiLCJzYXAiOiJTdktlcm5lTCIsImFwaSI6IkFkZExvZ2luIiwiem9uZSI6IlhkVWFYZHVBIiwiY29ycCI6IlhkVWFYZHVBIiwic2hvcCI6IlhkVWFYZHVBIiwicm9sZSI6IioiLCJydWxlIjoiKiIsImJ1ZyI6IkRFIiwidGlkIjoiUklHTktyUm4iLCJsZ24iOiJrZkFKOXZhaCJ9.k358orbypFBqJH4ieOJT9MBqTH5RtojCYvyps9gQEEZVmy2lCDRSLThRa99HhXvlTzujh7sjOwS-faw2JNOt8gFXkeQ5gbdBh1tScUKAMU3jzAC9QC2OdiOfjbS3Q7p86JhqdOWBSjsUroGeTF4X5mTKmJQuj4hobgCQKbzZ1lcgw3VpkjJP7gTUv7dAq14nk4pAm7fbSEJ1PGU_NKL2mZSoxLzsvi4xU-NvjDGE79twkiGd5QiNWzICZPa_Q67JnflOWVaOhm-7e40GDAFuZHYE4hp2jj3BKcVPK4ihn7lon2HRZ36IszloKuPjUW955TPKov4fQAbjexthSkSPXA'
    },
}
名称 位置 类型 示例 说明
id result string rYub4wrT 创建的用户ID
token String 社登后的令牌,建议客户端在本地存储保存这个令牌，以便在接下来多次使用。

错误码

SDK调用

const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
    LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})

/**如果是电话号码登录**/
const api_param = {
    ustr:   '+86-15810419011',
    pwd :   'a906449d5769fa7361d7ecc6aa3f6d28',
    afs :   '人机验证码',
}

/**如果是邮箱账号登录**/
const api_param = {
    ustr:   'jiaoshuaihit@163.com',
    pwd :   'a906449d5769fa7361d7ecc6aa3f6d28',
}

/**如果是名字账号登录**/
api_name = "微信用户名登录";
const api_param = {
    ustr:   '辣椒帅',
    pwd :   'a906449d5769fa7361d7ecc6aa3f6d28',
}


/**微信网站扫码登录**/
api_name = "微信网站扫码登录";
const api_param = {
    ustr:   '001C5sHa1TDsVz0ie9Ha1VlwCv2C5sHE',
}
let res = await xduaClient.addWoginx(login_param)



/**在adminx.xdua.com上电话登录**/
let res = await xduaClient.addToginx(api_param)
/**在adminx.xdua.com上邮箱登录**/
let res = await xduaClient.addMoginx(api_param)
/**在adminx.xdua.com上户名登录**/
let res = await xduaClient.addNoginx(api_param)
/**在adminx.xdua.com上微信登录**/
let res = await xduaClient.addWoginx(api_param)



/**在应用级网站上电话登录**/
let res = await xduaClient.addToginr(api_param)
/**在应用级网站上邮箱登录**/
let res = await xduaClient.addMoginx(api_param)
/**在应用级网站上户名登录**/
let res = await xduaClient.addNoginx(api_param)
/**在应用级网站上微信登录**/
let res = await xduaClient.addWoginx(api_param)


console.log(res);
console.log(JSON.stringify(res));
if(res.error == 0){
    console.log(api_name+"成功 ");
}else{
    console.log(api_name+"失败 "+res.reason);
}


XduaClientHttpApi.getInstance().AddToginx( "+86-15810419011" , "a906449d5769fa7361d7ecc6aa3f6d28" , "afs_example" , new ApiCallback() {
    @Override
    public void onFailure(ApiRequest request, Exception e) {
        e.printStackTrace();
    }

    @Override
    public void onResponse(ApiRequest request, ApiResponse response) {
        try {
            System.out.println(getResultString(response));
        }catch (Exception ex){
            ex.printStackTrace();
        }
    }
});

描述

创建社登。

调用场景

  • 开发者在浏览器SDK测试应用BrowSdkT社登。
  • 开发者社登超级控制台以应用ConsoleX社登。
  • 开发者社登社区控制台以某些社区应用社登。
  • 客户在智慧养老手机APP端社登
  • 客户在智慧城市手机APP端社登

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name AddLoginr
Url https://api.xdua.com/loginrr
Method POST
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod ADD
XduaApiColor X 只有持有神社登，才可以创建社登
XduaApiAudience * 任何app都可以创建社登
XduaApiShop XdUaXduA 社登直辖店铺,只有这个店铺的社登人员才可以访问
XduaApiSubject AnoNymuS 必须匿名用户才可以用
XduaApiRoles Zoon Zoon可以创建社登
XduaApiResource loginr
XduaApiKparam name
XduaApiAction CreateLoginr
XduaApiRule CreateLoginr
XduaApiAstates 0
XduaApiEnable true 接口使能

请求参数

名称 位置 类型 必填 默认值 示例 说明
by body String 否 "tel"/"mail" 必选
ustr body String 否 电话格式是+86-15810419011/邮箱格式是:jiaoshuai@ict.ac.cn 必选
pwd body String 否 密码,32位md5码 必选
shop body String 否 店铺 必选
role body String 否 角色,默认"none" 可选

[!NOTE] 因为大多数用户都是普通注册用户，为他们维持在授角表的位置太浪费空间。所以普通注册用户仅仅在user表维持一席之地，并不在usro占据空间。

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

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

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 创建的用户ID
token String 社登后的令牌,建议客户端在本地存储保存这个令牌，以便在接下来多次使用。
expire String 社登令牌的截至时间，UNIX时间。
roles JsonList 用户本次社登使用的角色列表
rules JsonList 用户本次社登使用的权限列表

错误码

SDK调用

登录社区

创建一次登录。

const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
    LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})

const api_param = {
    ustr:   'jiaoshuaihit@163.com',
    pwd :   'a906449d5769fa7361d7ecc6aa3f6d28',
}
let res = await xduaClient.addMoginr(api_param)
console.log(res);
console.log(JSON.stringify(res));
if(res.error == 0){
    console.log(api_name+"成功 ");
}else{
    console.log(api_name+"失败 "+res.reason);
}

文档还没有实现

```


文档还没有实现

```bash

文档还没有实现

```


#### 描述

创建社登。

#### 调用场景

+ 开发者在浏览器SDK测试应用BrowSdkT社登。
+ 开发者社登[超级控制台](http://consolex.xdua.com)以应用ConsoleX社登。
+ 开发者社登[社区控制台](http://consoler.********.xdua.com)以某些社区应用社登。
+ 客户在智慧养老手机APP端社登
+ 客户在智慧城市手机APP端社登

#### 配置参数

参数意义参考[接口参数](http://docapi.xdua.com/api/param.html)

|参数名                 |参数值                   |说明     |
|------                 |------                   |----     |
|Name                   |AddLoginr                  |         |
|Url                    |https://api.xdua.com/loginrr|         |
|Method                 |POST                     |         |
|XduaApiHttpSchema      |HTTPS                    | 只走HTTPS|
|XduaApiMethod          |ADD                      |         |
|XduaApiColor           |X                        | 只有持有神社登，才可以创建社登        |
|XduaApiAudience        |*                        | 任何app都可以创建社登|
|XduaApiShop            |XdUaXduA                 | 社登直辖店铺,只有这个店铺的社登人员才可以访问|
|XduaApiSubject         |AnoNymuS                 | 必须匿名用户才可以用|
|XduaApiRoles           |Zoon                     | Zoon可以创建社登|
|XduaApiResource        |loginr                     |     |
|XduaApiKparam          |name                     |     |
|XduaApiAction          |CreateLoginr               |     |
|XduaApiRule            |CreateLoginr               |     |
|XduaApiAstates         |0                         |    |
|XduaApiEnable          |true                     | 接口使能    |



#### 请求参数


|名称       | 位置|类型     |必填    |默认值    |示例                       |说明                       |
|-------    |-----|---------|--------|--------  |--------                   |------------               |
|by         |body |String   |否      |          |                           |"tel"/"mail"      |必选|
|ustr       |body |String   |否      |          |                           |电话格式是+86-15810419011/邮箱格式是:jiaoshuai@ict.ac.cn|必选|
|pwd        |body |String   |否      |          |                           |密码,32位md5码 |必选|
|shop       |body |String   |否      |          |                           |店铺           |必选|
|role       |body |String   |否      |          |                           |角色,默认"none"|可选|

> [!NOTE]
> 因为大多数用户都是普通注册用户，为他们维持在授角表的位置太浪费空间。所以普通注册用户仅仅在user表维持一席之地，并不在usro占据空间。 



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

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



#### 返回参数

|名称      | 位置  |类型       |示例        |说明                                                           |
|-------   |-----  |-----------|------------|------------                                                   |
|id        |result |string     |rYub4wrT    |创建的用户ID                                                   |
|token  |String|社登后的令牌,建议客户端在本地存储保存这个令牌，以便在接下来多次使用。|
|expire |String|社登令牌的截至时间，UNIX时间。|
|roles  |JsonList|用户本次社登使用的角色列表|
|rules  |JsonList|用户本次社登使用的权限列表|



#### 错误码


#### SDK调用

#### 登录社区 

创建一次登录。




```javascript
const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
    LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})

const api_param = {
    ustr:   '辣椒帅',
    pwd :   'a906449d5769fa7361d7ecc6aa3f6d28',
}
let res = await xduaClient.addNoginr(api_param)
console.log(res);
console.log(JSON.stringify(res));
if(res.error == 0){
    console.log(api_name+"成功 ");
}else{
    console.log(api_name+"失败 "+res.reason);
}

文档还没有实现

```


文档还没有实现

```bash

文档还没有实现

```


#### 描述

创建社登。

#### 调用场景

+ 开发者在浏览器SDK测试应用BrowSdkT社登。
+ 开发者社登[超级控制台](http://consolex.xdua.com)以应用ConsoleX社登。
+ 开发者社登[社区控制台](http://consoler.********.xdua.com)以某些社区应用社登。
+ 客户在智慧养老手机APP端社登
+ 客户在智慧城市手机APP端社登

#### 配置参数

参数意义参考[接口参数](http://docapi.xdua.com/api/param.html)



#### 请求参数


|名称       | 位置|类型     |必填    |默认值    |示例                       |说明                       |
|-------    |-----|---------|--------|--------  |--------                   |------------               |
|by         |body |String   |否      |          |                           |"tel"/"mail"      |必选|
|ustr       |body |String   |否      |          |                           |电话格式是+86-15810419011/邮箱格式是:jiaoshuai@ict.ac.cn|必选|
|pwd        |body |String   |否      |          |                           |密码,32位md5码 |必选|
|shop       |body |String   |否      |          |                           |店铺           |必选|
|role       |body |String   |否      |          |                           |角色,默认"none"|可选|

> [!NOTE]
> 因为大多数用户都是普通注册用户，为他们维持在授角表的位置太浪费空间。所以普通注册用户仅仅在user表维持一席之地，并不在usro占据空间。 



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

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



#### 返回参数

```json
{
    status: 200,
    apid: 'F0B8FF02-B970-4DA3-9ED2-8543A84EB474',
    apis: 'AddToginx',
    error: 0,
    reason: 'success',
    message: 'Success.',
    result: {
        id: 'Dt5mvrtU',
        token: 'eyJhbGciOiJSUzI1NiIsImtpZCI6ImI1MGIxZWZmZGMwMzVlMjg2OWI2YzQ1ZjMzYmRmNWQ3In0.eyJpYXQiOjE2MDY3MDI1NDksIm5iZiI6MTYwNjcwMjU0OSwiaXNzIjoieGR1YS5jb20iLCJleHAiOjE2MDY3MDMxNDksImF1ZCI6IkJyb3dTZGtUIiwic3ViIjoiRHQ1bXZydFUiLCJqdGkiOiIxMjM0NTY3OCIsInR5cCI6IlUiLCJ0YWciOiJQcmltYXJ5IiwiY2xyIjoiWCIsImlwbSI6IioiLCJkdm0iOiIqIiwib3duIjoiRHQ1bXZydFUiLCJzYXAiOiJTdktlcm5lTCIsImFwaSI6IkFkZExvZ2luIiwiem9uZSI6IlhkVWFYZHVBIiwiY29ycCI6IlhkVWFYZHVBIiwic2hvcCI6IlhkVWFYZHVBIiwicm9sZSI6IioiLCJydWxlIjoiKiIsImJ1ZyI6IkRFIiwidGlkIjoiUklHTktyUm4iLCJsZ24iOiJrZkFKOXZhaCJ9.k358orbypFBqJH4ieOJT9MBqTH5RtojCYvyps9gQEEZVmy2lCDRSLThRa99HhXvlTzujh7sjOwS-faw2JNOt8gFXkeQ5gbdBh1tScUKAMU3jzAC9QC2OdiOfjbS3Q7p86JhqdOWBSjsUroGeTF4X5mTKmJQuj4hobgCQKbzZ1lcgw3VpkjJP7gTUv7dAq14nk4pAm7fbSEJ1PGU_NKL2mZSoxLzsvi4xU-NvjDGE79twkiGd5QiNWzICZPa_Q67JnflOWVaOhm-7e40GDAFuZHYE4hp2jj3BKcVPK4ihn7lon2HRZ36IszloKuPjUW955TPKov4fQAbjexthSkSPXA'
    },
}
名称 位置 类型 示例 说明
id result string rYub4wrT 创建的用户ID
token String 社登后的令牌,建议客户端在本地存储保存这个令牌，以便在接下来多次使用。

错误码

SDK调用

const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
    LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})

const api_param = {
    ustr:   '+86-15810419011',
    pwd :   'a906449d5769fa7361d7ecc6aa3f6d28',
    afs :   '人机验证码',
}
let res = await xduaClient.addToginr(api_param)
console.log(res);
console.log(JSON.stringify(res));
if(res.error == 0){
    console.log(api_name+"成功 ");
}else{
    console.log(api_name+"失败 "+res.reason);
}

文档还没有实现

```


文档还没有实现


XduaClientHttpApi.getInstance().AddToginx( "+86-15810419011" , "a906449d5769fa7361d7ecc6aa3f6d28" , "afs_example" , new ApiCallback() {
    @Override
    public void onFailure(ApiRequest request, Exception e) {
        e.printStackTrace();
    }

    @Override
    public void onResponse(ApiRequest request, ApiResponse response) {
        try {
            System.out.println(getResultString(response));
        }catch (Exception ex){
            ex.printStackTrace();
        }
    }
});


```bash

文档还没有实现

```


#### 描述

删除神登。

#### 调用场景

根用户在[超级控制台](http://consolex.xdua.com)神登. 它会让资源永久消失。。

#### 配置参数

参数意义参考[接口参数](http://docapi.xdua.com/api/param.html)

|参数名                 |参数值                   |说明     |
|------                 |------                   |----     |
|Name                   |DelLoginx                  |         |
|URL                    |https://api.xdua.com/loginxx|         |
|Method                 |DELETE                     |         |
|XduaApiHttpSchema      |HTTPS                    | 只走HTTPS|
|XduaApiMethod          |DEL                      |         |
|XduaApiColor           |X                        | 只有持有神神登，才可以创建神登        |
|XduaApiAudience        |ConsoleX                 | 只有loginx_id为ConsoleX的神登，也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop            |XdUaXduA                 | 神登直辖店铺,只有这个店铺的神登人员才可以访问|
|XduaApiSubject         |i                        | 只有资源创建者自己可以访问这个口|
|XduaApiRoles           |Zoon                     | Zoon可以删除神登|
|XduaApiResource        |loginx                     |     |
|XduaApiKparam          |id                       |     |
|XduaApiAction          |DeleteLoginx               |     |
|XduaApiRule            |DeleteLoginx               |     |
|XduaApiAstates         |0              | 按序loginx,zone,corp,shop,user,loginx,loginx的状态都必须是0(STATE_ENABLED)    |
|XduaApiEnable          |true                     | 接口使能    |



#### 请求参数

|名称       | 位置|类型     |必填    |默认值  |示例    |说明                |
|-------    |-----|---------|--------|--------|--------|------------        |
|id         |path |string   |是      |        |rYub4wrT|要删除的神登ID      |

#### 返回参数

|名称      | 位置  |类型       |示例        |说明                           |
|-------   |-----  |-----------|------------|------------                   |
|id        |result |string     |rYub4wrT    |删除的神登ID                   |


#### 错误码


#### 描述

关闭神登。

#### 调用场景

神管理员神登[超级控制台](http://consolex.xdua.com)后,可以关闭普通开发者的神登。使得神登进入DISABLED状态，也只有Zoon角色重新打开这个神登。

管理员（Zoon）

1. 神登[http://consoler.{zond_id}.xdua.com](http://consoler.xdua.com)后,
2. 根据条件查询神登，条件是某个神登。
3. 点击`冻结`，可以关闭神登。


#### 配置参数

参数意义参考[接口参数](http://docapi.xdua.com/api/param.html)

|参数名                 |参数值                   |说明     |
|------                 |------                   |----     |
|Name                   |DisLoginx                  |         |
|URL                    |https://api.xdua.com/loginxx|         |
|Method                 |PUT                     |         |
|XduaApiHttpSchema      |HTTPS                    | 只走HTTPS|
|XduaApiMethod          |DIS                      |         |
|XduaApiColor      |X                        | 只有持有神神登，才可以创建神登        |
|XduaApiAudience   |ConsoleX                 | 只有loginx_id为ConsoleX的神登，也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop       |XdUaXduA                 | 神登直辖神登,只有这个神登的神登人员才可以访问|
|XduaApiSubject    |i                        | 必须是创建者才可以自闭神登|
|XduaApiRoles           |Admin                     | 只有神级管理员才可以关闭普通开发者的神登|
|XduaApiResource        |loginx                     |     |
|XduaApiKparam          |id                       |     |
|XduaApiAction          |DisableLoginx               |     |
|XduaApiRule            |DisableLoginx               |     |
|XduaApiAstates         |`0,0` 或者`0`         | 按序loginx,zone,corp,shop,user,loginx,loginx的状态都必须是0(STATE_ENABLED)    |
|XduaApiEnable          |true                     | 接口使能    |



#### 请求参数

|名称       | 位置|类型     |必填    |默认值  |示例    |说明                |
|-------    |-----|---------|--------|--------|--------|------------        |
|id         |path |string   |是      |        |rYub4wrT|要删除的神登ID      |

#### 返回参数

|名称      | 位置  |类型       |示例        |说明                           |
|-------   |-----  |-----------|------------|------------                   |
|id        |result |string     |rYub4wrT    |删除的神登ID                   |


#### 错误码


#### 描述

软删神登。

#### 调用场景

开发者神登[超级控制台](http://consolex.xdua.com)后,可以点击自己的神登，然后删除掉。如果哪天后悔了，可以联系Zoon来恢复。


#### 配置参数

参数意义参考[接口参数](http://docapi.xdua.com/api/param.html)

|参数名                 |参数值                   |说明     |
|------                 |------                   |----     |
|Name                   |DolLoginx                  |         |
|URL                    |https://api.xdua.com/loginxx|         |
|Method                 |PUT                     |         |
|XduaApiHttpSchema      |HTTPS                    | 只走HTTPS|
|XduaApiMethod          |DOL                      |         |
|XduaApiColor      |X                        | 只有持有神神登，才可以创建神登        |
|XduaApiAudience   |ConsoleX                 | 只有loginx_id为ConsoleX的神登，也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop       |XdUaXduA                 | 神登直辖店铺,只有这个店铺的神登人员才可以访问|
|XduaApiSubject    |i                        | 只有创建者自己才能删除自己创建的神登|
|XduaApiRoles           |Zoon                     | 只要神登就可以创建神登|
|XduaApiResource        |loginx                     |     |
|XduaApiKparam          |id                      |     |
|XduaApiAction          |DeletoLoginx               |     |
|XduaApiRule            |DeletoLoginx               |     |
|XduaApiAstates         |0              | 按序loginx,zone,corp,shop,user,loginx,loginx的状态都必须是0(STATE_ENABLED)    |
|XduaApiEnable          |true                     | 接口使能    |



#### 请求参数

|名称       | 位置|类型     |必填    |默认值  |示例    |说明                |
|-------    |-----|---------|--------|--------|--------|------------        |
|id         |path |string   |是      |        |rYub4wrT|要删除的神登ID      |

#### 返回参数

|名称      | 位置  |类型       |示例        |说明                           |
|-------   |-----  |-----------|------------|------------                   |
|id        |result |string     |rYub4wrT    |删除的神登ID                   |


#### 错误码


#### 描述

打开神登。

#### 调用场景

管理员（Zoon）

1. 神登[http://consolex.xdua.com](http://consoler.xdua.com)后,
2. 根据条件查询神登，条件是某个被冻结的神登。
3. 点击`解冻`，可以解冻店铺。



#### 配置参数

参数意义参考[接口参数](http://docapi.xdua.com/api/param.html)

|参数名                 |参数值                   |说明     |
|------                 |------                   |----     |
|Name                   |EnbLoginx                  |         |
|URL                    |https://api.xdua.com/loginxx|         |
|Method                 |PUT                     |         |
|XduaApiHttpSchema      |HTTPS                    | 只走HTTPS|
|XduaApiMethod          |ENB                      |         |
|XduaApiColor      |X                        | 只有持有神神登，才可以创建神登        |
|XduaApiAudience   |ConsoleX                 | 只有loginx_id为ConsoleX的神登，也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop       |XdUaXduA                 | 神登直辖店铺,只有这个店铺的神登人员才可以访问|
|XduaApiSubject    |u                        | 神神登后解冻开发者的神登|
|XduaApiRoles           |Admin                     | 只有神才可以解冻神登|
|XduaApiResource        |loginx                     |     |
|XduaApiKparam          |id                       |     |
|XduaApiAction          |EnableLoginx               |     |
|XduaApiRule            |EnableLoginx               |     |
|XduaApiAstates         |0              | 按序loginx,zone,corp,shop,user,loginx,loginx的状态都必须是0(STATE_ENABLED)    |
|XduaApiEnable          |true                     | 接口使能    |



#### 请求参数

|名称       | 位置|类型     |必填    |默认值  |示例    |说明                |
|-------    |-----|---------|--------|--------|--------|------------        |
|id         |path |string   |是      |        |rYub4wrT|要删除的神登ID      |

#### 返回参数

|名称      | 位置  |类型       |示例        |说明                           |
|-------   |-----  |-----------|------------|------------                   |
|id        |result |string     |rYub4wrT    |删除的神登ID                   |


#### 错误码


#### 描述

详情神登。


#### 调用场景

管理员神登[超级控制台](http://consolex.xdua.com)后,可以随意查询能看见的所有神登列表。点击其中一个神登（不管是不是自己的），就可以点击访问。


#### 配置参数

|参数名                 |参数值                   |说明     |
|------                 |------                   |----     |
|URL                    |https://api.xdua.com/loginxx|         |
|Method                 |GET                      |         |
|XduaApiHttpSchema      |HTTPS                    | 只走HTTPS|
|XduaApiMethod          |GET                      |         |
|XduaApiColor      |X                        | 只有持有神神登，才可以创建神登        |
|XduaApiAudience   |ConsoleX                 | 只有loginx_id为ConsoleX的神登，也就是consolex.xdua.com才可以发起本请求|
|XduaApiShop       |XdUaXduA                 | 神登直辖店铺,只有这个店铺的神登人员才可以访问|
|XduaApiSubject    |i                        | !表示除了允许匿名用户之外的所有用户访问|
|XduaApiRoles           |Zoon                     | 只要Zoon才可以访问其它用户的神登|
|XduaApiResource        |loginx                     |     |
|XduaApiKparam          |id                       |     |
|XduaApiAction          |GetLoginx               |     |
|XduaApiRule            |GetLoginx               |     |
|XduaApiLoginxAstate      |0                        | 神登zone.state必须是0(STATE_ENABLED)    |
|XduaApiCorpAstate      |0                        | 神登corp.state必须是0(STATE_ENABLED)    |
|XduaApiShopAstate      |0                        | 神登shop.state必须是0(STATE_ENABLED)    |
|XduaApiUserAstate      |0                        | 神登user.state必须是0(STATE_ENABLED)    |
|XduaApiLoginxAstate       |0                        | 神登 loginx.state必须是0(STATE_ENABLED)    |
|XduaApiLoginxAstate     |0                        | 神登loginx.state必须是0(STATE_ENABLED)    |
|XduaApiEnable          |true                     | 接口使能    |



#### 请求参数

|名称       | 位置|类型     |必填    |默认值  |示例    |说明                |
|-------    |-----|---------|--------|--------|--------|------------        |
|id         |path |string   |是      |        |rYub4wrT|要修改的神登ID      |

#### 返回参数


|名称       | 位置          |类型       |示例                   |说明                          |
|-------    |-----          |-----------|------------           |------------                  |
|id         |result         |string     |rYub4wrT               |详情的角权ID                  |
|name       |result.data    |string     |                       |角权的名称                    |
|code       |result.data    |string     |                       |角权的执照号                  |
|type       |result.data    |string     |                       |角权的种类                    |
|avatar     |result.data    |string     |                       |角权图标                      |
|brief      |result.data    |string     |                       |角权的描述                    |
|state      |result.data    |int        |1                      |角权的状态                    |
|stato      |result.data    |string     |"冻服更新"             |角权的状态说明                |
|expire     |result.data    |int        |0                      |角权状态过期时间(UNIX时间戳)  |
|creator_id |result.list[]  |string     |Dmtv7TrE               |社区创建者ID                  |
|creator_name |result.list[]  |string   |辣椒帅                 |社区创建者名字                  |
|ipdator_id |result.list[]  |string     |XiyRvUp3               |社区最近一次更新者ID                  |
|ipdator_name |result.list[]  |string   |周海潮                 |社区最近一次更新者名字                  |
|cstamp     |result.data    |string     |2020-01-20 02:19:55    |角权创建时间  |
|istamp     |result.data    |string     |2020-01-20 02:23:24    |角权最近更新时间  |

|字段名  |字段类型 | 字段说明            |
|:-------|-------- |---------            |
|id      |string   |角权的id             |
|loginx_id    |string   |所属户群的id           |
|loginx_name    |string   |所属户群的名字           |
|igrp_id    |string   |所属户群的id           |
|igrp_name    |string   |所属户群的名字           |
|code    |string   |角权的代号           |
|name    |string   |角权名               |
|brief   |string   |角权说明             |
|avatar  |string   |角权的头像           |
|enabeld |int      |角权的使能状态       |
|cstamp  |string   |创建的时间戳字符串   |
|istamp  |string   |更新的时间戳字符串   |

|字段名  |字段类型 | 字段说明            |
|:-------|-------- |---------            |
|id      |string   |角权的id             |
|roue_id    |string   |所属户群的id           |
|roue_name    |string   |所属户群的名字           |
|igrp_id    |string   |所属户群的id           |
|igrp_name    |string   |所属户群的名字           |
|code    |string   |角权的代号           |
|name    |string   |角权名               |
|brief   |string   |角权说明             |
|avatar  |string   |角权的头像           |
|enabeld |int      |角权的使能状态       |
|cstamp  |string   |创建的时间戳字符串   |
|istamp  |string   |更新的时间戳字符串   |


|字段名  |字段类型 | 字段说明            |
|:-------|-------- |---------            |
|verified|int      |1=神登是有效的|
|did     |string   |请求该神登的设备id|
|uid     |string   |神登吃鱼者用户id。匿名神登的用户永远是anonymus|
|did     |string   |请求该神登的设备id|
|aid     |string   |请求该神登的设备id|
|aud     |string   |请求该神登的应用的名字,本字段与aid对应|
|nbf     |int      |Not Before神登生效时间之前|
|iss     |string   |神登签发机关。在地球号服务中本字段为常值lovearth|
|iat     |string   |神登签发UTC时间戳|
|ip      |string   |神登请求时客户端的ip|
|ua      |string   |神登请求时客户端的UserAgent|
|exp     |int      |神登的过期UTC时间戳。如果<=0表示永远有效。如果大于0表示具体的UTC时间。|
|vtl     |int      |神登的剩余有效期   ValidTimeLong.0表示永远。如果exp为0,vtl就会被解释为0。如果一个非永远的loginx计算vtl为0时，会自动被重置为-1|
|ugrp    |string   |神登持有用户所在的用户群,匿名用户的户群是常量:"XdUaXduA"|
|role    |string   |神登持有用户所在的角色列表,匿名用户的角色列表是常量:"none"|



#### 返回示例

result部分
```json
{
    "id":"rYub4wrT",
    "data": {


    },
}

错误码

描述

私详神登。

调用场景

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

配置参数

参数名 参数值 说明
URL https://api.xdua.com/loginxx
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod GIT
XduaApiColor X 只有持有神神登，才可以创建神登
XduaApiAudience ConsoleX 只有loginx_id为ConsoleX的神登，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 神登直辖店铺,只有这个店铺的神登人员才可以访问
XduaApiSubject i 只有自己才可以访问自己创建的神登
XduaApiRoles Zoon 只要神登就可以创建神登
XduaApiResource loginx
XduaApiKparam id
XduaApiAction GetLoginx
XduaApiRule GetLoginx
XduaApiLoginxAstate 0 神登zone.state必须是0(STATE_ENABLED)
XduaApiCorpAstate 0 神登corp.state必须是0(STATE_ENABLED)
XduaApiShopAstate 0 神登shop.state必须是0(STATE_ENABLED)
XduaApiUserAstate 0 神登user.state必须是0(STATE_ENABLED)
XduaApiLoginxAstate 0 神登 loginx.state必须是0(STATE_ENABLED)
XduaApiLoginxAstate 0 神登loginx.state必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要修改的神登ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 详情的神登ID
name result.data string 神登的名称
avatar result.data string 神登图标
brief result.data string 神登的描述
state result.data int 1 神登的状态
stato result.data string "冻服更新" 神登的状态说明
expire result.data int 0 神登状态过期时间(UNIX时间戳)
creator_id result.list[] string Dmtv7TrE 神登创建者ID
creator_name result.list[] string 辣椒帅 神登创建者名字
ipdator_id result.list[] string XiyRvUp3 神登最近一次更新者ID
ipdator_name result.list[] string 周海潮 神登最近一次更新者名字
cstamp result.data string 2020-01-20 02:19:55 神登创建时间
istamp result.data string 2020-01-20 02:23:24 神登最近更新时间

返回示例

result部分

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


    },
}

错误码

描述

下线神登。

调用场景

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

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name OffLoginx
URL https://api.xdua.com/loginxx
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod OFF
XduaApiColor X 只有持有神神登，才可以创建神登
XduaApiAudience ConsoleX 只有loginx_id为ConsoleX的神登，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 神登直辖店铺,只有这个店铺的神登人员才可以访问
XduaApiSubject i 只能神登的创建者才能下线自己的神登
XduaApiRoles Zoon 只要神登就可以创建神登
XduaApiResource loginx
XduaApiKparam id
XduaApiAction OfflineLoginx
XduaApiRule OfflineLoginx
XduaApiAstates 0 按序loginx,zone,corp,shop,user,loginx,loginx的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要删除的神登ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的神登ID

错误码

描述

发布神登。

调用场景

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

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name PubLoginx
URL https://api.xdua.com/loginxx
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod PUB
XduaApiColor X 只有持有神神登，才可以创建神登
XduaApiAudience ConsoleX 只有loginx_id为ConsoleX的神登，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 神登直辖店铺,只有这个店铺的神登人员才可以访问
XduaApiSubject i 只有神登的创建者自己才能上下线自己的神登
XduaApiRoles Zoon 只要神登就可以创建神登
XduaApiResource loginx
XduaApiKparam id
XduaApiAction OnlineLoginx
XduaApiRule OnlineLoginx
XduaApiAstates 0 按序loginx,zone,corp,shop,user,loginx,loginx的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要删除的神登ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的神登ID

错误码

描述

私查神登。

调用场景

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

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name QriLoginx
URL https://api.xdua.com/loginxx
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod QRI
XduaApiColor X 只有持有神神登，才可以创建神登
XduaApiAudience ConsoleX 只有loginx_id为ConsoleX的神登，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 神登直辖店铺,只有这个店铺的神登人员才可以访问
XduaApiSubject i 所有注册用户均可以使用
XduaApiRoles Zoon 必须是Zoon才可以查询角色
XduaApiResource loginx
XduaApiKparam where 常量
XduaApiAction QueriLoginx
XduaApiRule QueriLoginx
XduaApiAstates 0 按序loginx,zone,corp,shop,user,loginx,loginx的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

URL

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

请求参数

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

返回参数

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

result.list部分

名称 位置 类型 示例 说明
id result string rYub4wrT 详情的神登ID
name result.list[] string 神登的名称
avatar result.list[] string 神登图标
brief result.list[] string 神登的描述
state result.list[] int 0 神登的状态
stato result.list[] string "冻服更新" 神登的状态说
expire result.list[] int 0 神登状态过期时间(UNIX时间戳)
creator_id result.list[] string Dmtv7TrE 神登创建者ID
creator_name result.list[] string 辣椒帅 神登创建者名字
ipdator_id result.list[] string XiyRvUp3 神登最近一次更新者ID
ipdator_name result.list[] string 周海潮 神登最近一次更新者名字
cstamp result.list[] string 2020-01-20 02:19:55 神登创建时间
istamp result.list[] string 2020-01-20 02:23:24 神登最近更新时间

错误码

描述

查询神登。

调用场景

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

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name QryLoginx
URL https://api.xdua.com/loginxx
Method GET
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod QRY
XduaApiColor X 只有持有神神登，才可以创建神登
XduaApiAudience ConsoleX 只有loginx_id为ConsoleX的神登，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 神登直辖店铺,只有这个店铺的神登人员才可以访问
XduaApiSubject u 所有注册用户均可以使用
XduaApiRoles Admin 必须是Zoon才可以查询角色
XduaApiResource loginx
XduaApiKparam where 常量where
XduaApiAction QueryLoginx
XduaApiRule QueryLoginx
XduaApiAstates 0 按序loginx,zone,corp,shop,user,loginx,loginx的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

URL

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

请求参数

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

返回参数

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

result.list部分

名称 位置 类型 示例 说明
id result string rYub4wrT 详情的神登ID
name result.list[] string 神登的名称
avatar result.list[] string 神登图标
brief result.list[] string 神登的描述
state result.list[] int 0 神登的状态
stato result.list[] string "冻服更新" 神登的状态说
expire result.list[] int 0 神登状态过期时间(UNIX时间戳)
creator_id result.list[] string Dmtv7TrE 神登创建者ID
creator_name result.list[] string 辣椒帅 神登创建者名字
ipdator_id result.list[] string XiyRvUp3 神登最近一次更新者ID
ipdator_name result.list[] string 周海潮 神登最近一次更新者名字
cstamp result.list[] string 2020-01-20 02:19:55 神登创建时间
istamp result.list[] string 2020-01-20 02:23:24 神登最近更新时间

result.list部分

名称 位置 类型 示例 说明
id result string rYub4wrT 详情的神登ID
name result.list[] string 神登的名称
avatar result.list[] string 神登图标
brief result.list[] string 神登的描述
state result.list[] int 0 神登的状态
stato result.list[] string "冻服更新" 神登的状态说
expire result.list[] int 0 神登状态过期时间(UNIX时间戳)
creator_id result.list[] string Dmtv7TrE 神登创建者ID
creator_name result.list[] string 辣椒帅 神登创建者名字
ipdator_id result.list[] string XiyRvUp3 神登最近一次更新者ID
ipdator_name result.list[] string 周海潮 神登最近一次更新者名字
cstamp result.list[] string 2020-01-20 02:19:55 神登创建时间
istamp result.list[] string 2020-01-20 02:23:24 神登最近更新时间

错误码

描述

回收神登。

调用场景

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

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name RccLoginx
URL https://api.xdua.com/loginxx
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod RCC
XduaApiColor X 只有持有神神登，才可以创建神登
XduaApiAudience ConsoleX 只有loginx_id为ConsoleX的神登，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 神登直辖店铺,只有这个店铺的神登人员才可以访问
XduaApiSubject i u表示除了允许匿名用户之外的所有用户访问
XduaApiRoles Zoon 只要神登就可以创建神登
XduaApiResource loginx
XduaApiKparam id
XduaApiAction RecycleLoginx
XduaApiRule RecycleLoginx
XduaApiAstates 0 按序loginx,zone,corp,shop,user,loginx,loginx的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要删除的神登ID

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 删除的神登ID

错误码

描述

修改神登。

调用场景

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

配置参数

参数意义参考接口参数

参数名 参数值 说明
Name SetLoginx
URL https://api.xdua.com/loginxx
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod SET
XduaApiColor X 只有持有神神登，才可以创建神登
XduaApiAudience ConsoleX 只有loginx_id为ConsoleX的神登，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 神登直辖店铺,只有这个店铺的神登人员才可以访问
XduaApiSubject i i,只有创建者自己才可以修改
XduaApiRoles Zoon 只要神登就可以创建神登
XduaApiResource loginx
XduaApiKparam id
XduaApiAction UpdateLoginx
XduaApiRule UpdateLoginx
XduaApiAstates 0 按序loginx,zone,corp,shop,user,loginx,loginx的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

请求参数

名称 位置 类型 必填 默认值 示例 说明
id path string 是 rYub4wrT 要修改的神登ID
name body string 否 神登的名称，必须唯一，支持汉字、英文字母、数字、英文格式的下划线，必须以英文字母或汉字开头，4~32个字符
avatar body string 否 神登图标，不超过40个字符。
brief body string 否 神登描述，不超过64个字符。

|secret |path|string|生成新的secret的kid|后端会用kid连同后台生成的随机数共同生成新的secret|必须 | |igrp |body|string|神登绑定的户群名|examp_ugrp|可选| |name |body|string|神登的名字|神登名字|可选| |brief |body|String|神登的介绍|神登简介|可选| |avatar |body|string|神登的图标url|http://开头的图片地址|可选| |enabled|body|String|使能|0:关闭 1：打开|可选|

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 修改的神登ID
ipdates result json dict 修改的内容

示例

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的神登名",
        "brief":"新的神登介绍",    
    }    
}

错误码

results matching ""

    No results matching ""