1. 创建老人
调用场景
- 微信小程序上授权老人可以创建一个老人老人,并自动产生关注关系,关系为Creator。
- 养老院后台在网页管理平台批量创建老人老人,并自动产生关注关系, 关系为Creator。
请求方式
POST:/elder
请求参数
名称 |
位置 |
类型 |
必填 |
默认值 |
示例 |
说明 |
Authorization |
head |
String |
是 |
|
|
使用老人登录后的令牌 |
name |
body |
string |
是 |
|
|
没有命名要求 |
gender |
body |
string |
否 |
|
U:未知, M:男性, F:女性。 |
性别 |
avatar |
body |
string |
否 |
|
https://avatar.xdua.com/user/example.png |
头像的URL地址 |
height |
body |
int |
否 |
|
178 |
身高,单位cm |
weight |
body |
int |
否 |
|
57 |
体重,单位kg |
age |
body |
int |
否 |
|
31 |
年龄,单位 年 |
返回参数
名称 |
位置 |
类型 |
示例 |
说明 |
id |
result |
string |
rYub4wrT |
创建的老人ID |
错误码
2. 删除老人
请求参数
名称 |
位置 |
类型 |
必填 |
默认值 |
示例 |
说明 |
id |
path |
string |
是 |
|
rYub4wrT |
要删除的老人ID |
返回参数
名称 |
位置 |
类型 |
示例 |
说明 |
id |
result |
string |
rYub4wrT |
删除的老人ID |
错误码
3. 关闭老人
请求参数
名称 |
位置 |
类型 |
必填 |
默认值 |
示例 |
说明 |
id |
path |
string |
是 |
|
rYub4wrT |
要删除的老人ID |
返回参数
名称 |
位置 |
类型 |
示例 |
说明 |
id |
result |
string |
rYub4wrT |
删除的老人ID |
错误码
4. 注销老人
描述
软删老人。
调用场景
开发者登录超级控制台后,可以点击自己的老人,然后删除掉。如果哪天后悔了,可以联系Zoon来恢复。
配置参数
参数意义参考接口参数
参数名 |
参数值 |
说明 |
Name |
DolUser |
|
URL |
https://api.xdua.com/user |
|
Method |
PUT |
|
XduaApiHttpSchema |
HTTPS |
只走HTTPS |
XduaApiMethod |
DOL |
|
XduaApiColor |
X |
只有持有神老人,才可以创建老人 |
XduaApiAudience |
ConsoleX |
只有user_id为ConsoleX的老人,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop |
XdUaXduA |
老人直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject |
i |
只有创建者自己才能删除自己创建的老人 |
XduaApiRoles |
Zoon |
只要登录就可以创建老人 |
XduaApiResource |
user |
|
XduaApiKparam |
id |
|
XduaApiAction |
DeletoUser |
|
XduaApiRule |
DeletoUser |
|
XduaApiAstates |
0 |
按序user,zone,corp,shop,user,user,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable |
true |
接口使能 |
请求参数
名称 |
位置 |
类型 |
必填 |
默认值 |
示例 |
说明 |
id |
path |
string |
是 |
|
rYub4wrT |
要删除的老人ID |
返回参数
名称 |
位置 |
类型 |
示例 |
说明 |
id |
result |
string |
rYub4wrT |
删除的老人ID |
错误码
5. 激活老人
描述
打开老人。
调用场景
管理员(Zoon)
- 登录http://consolex.xdua.com后,
- 根据条件查询老人,条件是某个被冻结的老人。
- 点击
解冻
,可以解冻店铺。
配置参数
参数意义参考接口参数
参数名 |
参数值 |
说明 |
Name |
EnbUser |
|
URL |
https://api.xdua.com/user |
|
Method |
PUT |
|
XduaApiHttpSchema |
HTTPS |
只走HTTPS |
XduaApiMethod |
ENB |
|
XduaApiColor |
X |
只有持有神老人,才可以创建老人 |
XduaApiAudience |
ConsoleX |
只有user_id为ConsoleX的老人,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop |
XdUaXduA |
老人直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject |
u |
神登录后解冻开发者的老人 |
XduaApiRoles |
Admin |
只有神才可以解冻老人 |
XduaApiResource |
user |
|
XduaApiKparam |
id |
|
XduaApiAction |
EnableUser |
|
XduaApiRule |
EnableUser |
|
XduaApiAstates |
0 |
按序user,zone,corp,shop,user,user,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable |
true |
接口使能 |
请求参数
名称 |
位置 |
类型 |
必填 |
默认值 |
示例 |
说明 |
id |
path |
string |
是 |
|
rYub4wrT |
要删除的老人ID |
返回参数
名称 |
位置 |
类型 |
示例 |
说明 |
id |
result |
string |
rYub4wrT |
删除的老人ID |
错误码
6. 回收老人
描述
回收老人。
调用场景
管理员应开发者的要求,登录超级控制台后,查询到某个开发者下面的被删除的老人。然后回收。开发者刷新就可以看到了。为此,开发者要提供自己的uid和要回收的老人的名字。
配置参数
参数意义参考接口参数
参数名 |
参数值 |
说明 |
Name |
RccUser |
|
URL |
https://api.xdua.com/user |
|
Method |
PUT |
|
XduaApiHttpSchema |
HTTPS |
只走HTTPS |
XduaApiMethod |
RCC |
|
XduaApiColor |
X |
只有持有神老人,才可以创建老人 |
XduaApiAudience |
ConsoleX |
只有user_id为ConsoleX的老人,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop |
XdUaXduA |
老人直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject |
i |
u表示除了允许匿名老人之外的所有老人访问 |
XduaApiRoles |
Zoon |
只要登录就可以创建老人 |
XduaApiResource |
user |
|
XduaApiKparam |
id |
|
XduaApiAction |
RecycleUser |
|
XduaApiRule |
RecycleUser |
|
XduaApiAstates |
0 |
按序user,zone,corp,shop,user,user,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable |
true |
接口使能 |
请求参数
名称 |
位置 |
类型 |
必填 |
默认值 |
示例 |
说明 |
id |
path |
string |
是 |
|
rYub4wrT |
要删除的老人ID |
返回参数
名称 |
位置 |
类型 |
示例 |
说明 |
id |
result |
string |
rYub4wrT |
删除的老人ID |
错误码
7. 回收老人
描述
回收老人。
调用场景
管理员应开发者的要求,登录超级控制台后,查询到某个开发者下面的被删除的老人。然后回收。开发者刷新就可以看到了。为此,开发者要提供自己的uid和要回收的老人的名字。
配置参数
参数意义参考接口参数
参数名 |
参数值 |
说明 |
Name |
RccUser |
|
URL |
https://api.xdua.com/user |
|
Method |
PUT |
|
XduaApiHttpSchema |
HTTPS |
只走HTTPS |
XduaApiMethod |
RCC |
|
XduaApiColor |
X |
只有持有神老人,才可以创建老人 |
XduaApiAudience |
ConsoleX |
只有user_id为ConsoleX的老人,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop |
XdUaXduA |
老人直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject |
i |
u表示除了允许匿名老人之外的所有老人访问 |
XduaApiRoles |
Zoon |
只要登录就可以创建老人 |
XduaApiResource |
user |
|
XduaApiKparam |
id |
|
XduaApiAction |
RecycleUser |
|
XduaApiRule |
RecycleUser |
|
XduaApiAstates |
0 |
按序user,zone,corp,shop,user,user,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable |
true |
接口使能 |
请求参数
名称 |
位置 |
类型 |
必填 |
默认值 |
示例 |
说明 |
id |
path |
string |
是 |
|
rYub4wrT |
要删除的老人ID |
返回参数
名称 |
位置 |
类型 |
示例 |
说明 |
id |
result |
string |
rYub4wrT |
删除的老人ID |
错误码
8. 修改老人
描述
修改老人。
调用场景
开发者登录超级控制台后,可以修改自己创建的老人。修改仅仅限于可以修改的name,brief等字段。
配置参数
参数意义参考接口参数
参数名 |
参数值 |
说明 |
Name |
SetUser |
|
URL |
https://api.xdua.com/user |
|
Method |
PUT |
|
XduaApiHttpSchema |
HTTPS |
只走HTTPS |
XduaApiMethod |
SET |
|
XduaApiColor |
X |
只有持有神老人,才可以创建老人 |
XduaApiAudience |
ConsoleX |
只有user_id为ConsoleX的老人,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop |
XdUaXduA |
老人直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject |
i |
i,只有创建者自己才可以修改 |
XduaApiRoles |
Zoon |
只要登录就可以创建老人 |
XduaApiResource |
user |
|
XduaApiKparam |
id |
|
XduaApiAction |
UpdateUser |
|
XduaApiRule |
UpdateUser |
|
XduaApiAstates |
0 |
按序user,zone,corp,shop,user,user,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable |
true |
接口使能 |
请求参数
名称 |
位置 |
类型 |
必填 |
默认值 |
示例 |
说明 |
id |
path |
string |
是 |
|
rYub4wrT |
要修改的老人ID |
name |
body |
string |
否 |
|
|
老人的名称,必须唯一,支持汉字、英文字母、数字、英文格式的下划线,必须以英文字母或汉字开头,4~32个字符 |
avatar |
body |
string |
否 |
|
|
老人图标,不超过40个字符。 |
brief |
body |
string |
否 |
|
|
老人描述,不超过64个字符。 |
名称 |
位置 |
类型 |
必填 |
默认值 |
示例 |
说明 |
id |
path |
string |
是 |
|
rYub4wrT |
要修改的老人ID |
code |
body |
string |
否 |
|
老人代号 |
老人营业执照号 |
type |
body |
string |
否 |
|
事业单位 |
老人种类 |
name |
body |
string |
否 |
|
老人名称 |
老人名称,不小于32个字符 |
brief |
body |
String |
否 |
|
华天逸键是一家专注老人健康的老人。 |
老人的简介。 |
avatar |
body |
string |
否 |
|
e10adc3949ba59abbe56e057f20f883e.jpg |
老人头像,不小于40个字符 |
name |
body |
string |
不能有空格,不能有回车,奇怪字符,对应成的英文不能超过64个字符 |
可选 |
saying |
body |
string |
对应成的英文不能超过128个字符,前后空格要过滤掉。 |
可选 |
sex |
body |
String |
U/F/M |
可选 |
bday |
body |
int |
8位的整形数据,如19870808,必须是合法日期 |
可选 |
avatar |
body |
string |
老人的头像必须是合法的url |
可选 |
brief |
body |
string |
老人的签名,对应英文字符不能超过256 |
可选 |
mail |
body |
string |
邮箱 |
可选 |
注:修改老人资料至少需要一个修改项。老人只能设置自己和马甲的接口.
返回参数
名称 |
位置 |
类型 |
示例 |
说明 |
id |
result |
string |
rYub4wrT |
修改的老人ID |
ipdates |
result |
json dict |
|
修改的内容 |
示例
result字段
{
"id":"rYub4wrT",
"updates":{
"name":"新的老人名",
"brief":"新的老人介绍",
}
}
错误码
9. 修改老人
描述
修改老人。
调用场景
开发者登录超级控制台后,可以修改自己创建的老人。修改仅仅限于可以修改的name,brief等字段。
配置参数
参数意义参考接口参数
参数名 |
参数值 |
说明 |
Name |
SetUser |
|
URL |
https://api.xdua.com/user |
|
Method |
PUT |
|
XduaApiHttpSchema |
HTTPS |
只走HTTPS |
XduaApiMethod |
SET |
|
XduaApiColor |
X |
只有持有神老人,才可以创建老人 |
XduaApiAudience |
ConsoleX |
只有user_id为ConsoleX的老人,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop |
XdUaXduA |
老人直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject |
i |
i,只有创建者自己才可以修改 |
XduaApiRoles |
Zoon |
只要登录就可以创建老人 |
XduaApiResource |
user |
|
XduaApiKparam |
id |
|
XduaApiAction |
UpdateUser |
|
XduaApiRule |
UpdateUser |
|
XduaApiAstates |
0 |
按序user,zone,corp,shop,user,user,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable |
true |
接口使能 |
请求参数
名称 |
位置 |
类型 |
必填 |
默认值 |
示例 |
说明 |
id |
path |
string |
是 |
|
rYub4wrT |
要修改的老人ID |
name |
body |
string |
否 |
|
|
老人的名称,必须唯一,支持汉字、英文字母、数字、英文格式的下划线,必须以英文字母或汉字开头,4~32个字符 |
avatar |
body |
string |
否 |
|
|
老人图标,不超过40个字符。 |
brief |
body |
string |
否 |
|
|
老人描述,不超过64个字符。 |
名称 |
位置 |
类型 |
必填 |
默认值 |
示例 |
说明 |
id |
path |
string |
是 |
|
rYub4wrT |
要修改的老人ID |
code |
body |
string |
否 |
|
老人代号 |
老人营业执照号 |
type |
body |
string |
否 |
|
事业单位 |
老人种类 |
name |
body |
string |
否 |
|
老人名称 |
老人名称,不小于32个字符 |
brief |
body |
String |
否 |
|
华天逸键是一家专注老人健康的老人。 |
老人的简介。 |
avatar |
body |
string |
否 |
|
e10adc3949ba59abbe56e057f20f883e.jpg |
老人头像,不小于40个字符 |
name |
body |
string |
不能有空格,不能有回车,奇怪字符,对应成的英文不能超过64个字符 |
可选 |
saying |
body |
string |
对应成的英文不能超过128个字符,前后空格要过滤掉。 |
可选 |
sex |
body |
String |
U/F/M |
可选 |
bday |
body |
int |
8位的整形数据,如19870808,必须是合法日期 |
可选 |
avatar |
body |
string |
老人的头像必须是合法的url |
可选 |
brief |
body |
string |
老人的签名,对应英文字符不能超过256 |
可选 |
mail |
body |
string |
邮箱 |
可选 |
注:修改老人资料至少需要一个修改项。老人只能设置自己和马甲的接口.
返回参数
名称 |
位置 |
类型 |
示例 |
说明 |
id |
result |
string |
rYub4wrT |
修改的老人ID |
ipdates |
result |
json dict |
|
修改的内容 |
示例
result字段
{
"id":"rYub4wrT",
"updates":{
"name":"新的老人名",
"brief":"新的老人介绍",
}
}
错误码
10. 查询老人
描述
查询老人。
调用场景
开发者登录http://consolex.xdua.com后,可以以Zoon角色查询属于自己名下的所有老人。
配置参数
参数意义参考接口参数
参数名 |
参数值 |
说明 |
Name |
QryUser |
|
URL |
https://api.xdua.com/user |
|
Method |
GET |
|
XduaApiHttpSchema |
HTTPS |
只走HTTPS |
XduaApiMethod |
QRY |
|
XduaApiColor |
X |
只有持有神老人,才可以创建老人 |
XduaApiAudience |
ConsoleX |
只有user_id为ConsoleX的老人,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop |
XdUaXduA |
老人直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject |
u |
所有注册老人均可以使用 |
XduaApiRoles |
Admin |
必须是Zoon才可以查询角色 |
XduaApiResource |
user |
|
XduaApiKparam |
where |
常量where |
XduaApiAction |
QueryUser |
|
XduaApiRule |
QueryUser |
|
XduaApiAstates |
0 |
按序user,zone,corp,shop,user,user,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable |
true |
接口使能 |
URL
GET:https://api.xdua.com/user
请求参数
参考标准查询接口请求参数
字段名 |
位置 |
类型 |
说明 |
描述 |
可选 |
apiv |
head |
string |
API版本,默认是1.0.0 |
1.0.0 |
可选 |
Authorization |
head |
string |
客户端保存的鉴权token |
Authorization字符串 |
必选 |
tabx |
query |
string |
老人表 |
老人表 |
可选 |
返回参数
参考标准查询接口返回参数
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 |
老人最近更新时间 |
错误码
11. 私查老人
描述
私查老人。
调用场景
开发者登录http://consolex.xdua.com后,可以以Zoon角色查询所有老人。
配置参数
参数意义参考接口参数
参数名 |
参数值 |
说明 |
Name |
QriUser |
|
URL |
https://api.xdua.com/user |
|
Method |
GET |
|
XduaApiHttpSchema |
HTTPS |
只走HTTPS |
XduaApiMethod |
QRI |
|
XduaApiColor |
X |
只有持有神老人,才可以创建老人 |
XduaApiAudience |
ConsoleX |
只有user_id为ConsoleX的老人,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop |
XdUaXduA |
老人直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject |
i |
所有注册老人均可以使用 |
XduaApiRoles |
Zoon |
必须是Zoon才可以查询角色 |
XduaApiResource |
user |
|
XduaApiKparam |
where |
常量 |
XduaApiAction |
QueriUser |
|
XduaApiRule |
QueriUser |
|
XduaApiAstates |
0 |
按序user,zone,corp,shop,user,user,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable |
true |
接口使能 |
URL
GET:https://api.xdua.com/user
请求参数
参考标准查询接口请求参数
返回参数
参考标准查询接口返回参数
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 |
老人最近更新时间 |
错误码
12. 详情老人
描述
详情老人。
调用场景
管理员登录超级控制台后,可以随意查询能看见的所有老人列表。点击其中一个老人(不管是不是自己的),就可以点击访问。
配置参数
参数名 |
参数值 |
说明 |
URL |
https://api.xdua.com/user |
|
Method |
GET |
|
XduaApiHttpSchema |
HTTPS |
只走HTTPS |
XduaApiMethod |
GET |
|
XduaApiColor |
X |
只有持有神老人,才可以创建老人 |
XduaApiAudience |
ConsoleX |
只有user_id为ConsoleX的老人,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop |
XdUaXduA |
老人直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject |
i |
!表示除了允许匿名老人之外的所有老人访问 |
XduaApiRoles |
Zoon |
只要Zoon才可以访问其它老人的老人 |
XduaApiResource |
user |
|
XduaApiKparam |
id |
|
XduaApiAction |
GetUser |
|
XduaApiRule |
GetUser |
|
XduaApiUserAstate |
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) |
XduaApiUserAstate |
0 |
老人 user.state必须是0(STATE_ENABLED) |
XduaApiUserAstate |
0 |
老人user.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 |
user_id |
string |
所属户群的id |
user_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。如果一个非永远的user计算vtl为0时,会自动被重置为-1 |
ugrp |
string |
老人持有老人所在的老人群,匿名老人的户群是常量:"XdUaXduA" |
role |
string |
老人持有老人所在的角色列表,匿名老人的角色列表是常量:"none" |
名称 |
位置 |
类型 |
示例 |
说明 |
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 |
辣椒帅 |
社区创建者名字 |
updator_id |
result.list[] |
string |
XiyRvUp3 |
社区最近一次更新者ID |
updator_name |
result.list[] |
string |
周海潮 |
社区最近一次更新者名字 |
cstamp |
result.data |
string |
2020-01-20 02:19:55 |
老人创建时间 |
ustamp |
result.data |
string |
2020-01-20 02:23:24 |
老人最近更新时间 |
[!note]
老人的使能状态,0:打开 1:关闭. 关闭的老人处于冻结状态,不接受登陆/注册所有操作.
返回示例
result部分
{
"id":"rYub4wrT",
"data": {
},
}
错误码
描述
私详老人。神级老人登录后获取自己的老人资料。
调用场景
开发者登录超级控制台后,在老人列表,选择老人,点击详情,就可以查看自己的老人。GIT的默认字段和GET不一样。
配置参数
参数名 |
参数值 |
说明 |
URL |
https://api.xdua.com/useri/whoami |
在私详状态下,user_id是没有任何用处的,因为发起请求的user_id隐藏在token中. |
Method |
GET |
|
XduaApiHttpSchema |
HTTPS |
只走HTTPS |
XduaApiMethod |
GIT |
|
XduaApiColor |
X |
只有持有神老人,才可以创建老人 |
XduaApiAudience |
ConsoleX |
只有user_id为ConsoleX的老人,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop |
XdUaXduA |
老人直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject |
i |
只有自己才可以访问自己创建的老人 |
XduaApiRoles |
Zoon |
只要登录就可以创建老人 |
XduaApiResource |
user |
|
XduaApiKparam |
id |
|
XduaApiAction |
GitUser |
|
XduaApiRule |
GitUser |
|
XduaApiUserAstate |
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) |
XduaApiUserAstate |
0 |
老人 user.state必须是0(STATE_ENABLED) |
XduaApiUserAstate |
0 |
老人user.state必须是0(STATE_ENABLED) |
XduaApiEnable |
true |
接口使能 |
请求参数
返回参数
名称 |
位置 |
类型 |
示例 |
说明 |
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 |
老人创建时间 |
ustamp |
result.data |
string |
2020-01-20 02:23:24 |
老人最近更新时间 |
返回示例
result部分
{
sex: 'f',
stato: '',
state: 0,
pid: 'AnoNymuS',
aid: 'SvKerneL',
avatar:'http:
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);
}
13. 下线老人
描述
下线老人。
调用场景
开发者登录超级控制台后,可以下线自己创建的老人。
配置参数
参数意义参考接口参数
参数名 |
参数值 |
说明 |
Name |
OffUser |
|
URL |
https://api.xdua.com/user |
|
Method |
PUT |
|
XduaApiHttpSchema |
HTTPS |
只走HTTPS |
XduaApiMethod |
OFF |
|
XduaApiColor |
X |
只有持有神老人,才可以创建老人 |
XduaApiAudience |
ConsoleX |
只有user_id为ConsoleX的老人,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop |
XdUaXduA |
老人直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject |
i |
只能老人的创建者才能下线自己的老人 |
XduaApiRoles |
Zoon |
只要登录就可以创建老人 |
XduaApiResource |
user |
|
XduaApiKparam |
id |
|
XduaApiAction |
OfflineUser |
|
XduaApiRule |
OfflineUser |
|
XduaApiAstates |
0 |
按序user,zone,corp,shop,user,user,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable |
true |
接口使能 |
请求参数
名称 |
位置 |
类型 |
必填 |
默认值 |
示例 |
说明 |
id |
path |
string |
是 |
|
rYub4wrT |
要删除的老人ID |
返回参数
名称 |
位置 |
类型 |
示例 |
说明 |
id |
result |
string |
rYub4wrT |
删除的老人ID |
错误码
14. 发布老人
描述
发布老人。
调用场景
开发者登录超级控制台后,可以下线/发布自己的老人。这个动作是管理员不能干涉的。
配置参数
参数意义参考接口参数
参数名 |
参数值 |
说明 |
Name |
PubUser |
|
URL |
https://api.xdua.com/user |
|
Method |
PUT |
|
XduaApiHttpSchema |
HTTPS |
只走HTTPS |
XduaApiMethod |
PUB |
|
XduaApiColor |
X |
只有持有神老人,才可以创建老人 |
XduaApiAudience |
ConsoleX |
只有user_id为ConsoleX的老人,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop |
XdUaXduA |
老人直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject |
i |
只有老人的创建者自己才能上下线自己的老人 |
XduaApiRoles |
Zoon |
只要登录就可以创建老人 |
XduaApiResource |
user |
|
XduaApiKparam |
id |
|
XduaApiAction |
OnlineUser |
|
XduaApiRule |
OnlineUser |
|
XduaApiAstates |
0 |
按序user,zone,corp,shop,user,user,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable |
true |
接口使能 |
请求参数
名称 |
位置 |
类型 |
必填 |
默认值 |
示例 |
说明 |
id |
path |
string |
是 |
|
rYub4wrT |
要删除的老人ID |
返回参数
名称 |
位置 |
类型 |
示例 |
说明 |
id |
result |
string |
rYub4wrT |
删除的老人ID |
错误码
15. 回收老人
描述
回收老人。
调用场景
管理员应开发者的要求,登录超级控制台后,查询到某个开发者下面的被删除的老人。然后回收。开发者刷新就可以看到了。为此,开发者要提供自己的uid和要回收的老人的名字。
配置参数
参数意义参考接口参数
参数名 |
参数值 |
说明 |
Name |
RccUser |
|
URL |
https://api.xdua.com/user |
|
Method |
PUT |
|
XduaApiHttpSchema |
HTTPS |
只走HTTPS |
XduaApiMethod |
RCC |
|
XduaApiColor |
X |
只有持有神老人,才可以创建老人 |
XduaApiAudience |
ConsoleX |
只有user_id为ConsoleX的老人,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop |
XdUaXduA |
老人直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject |
i |
u表示除了允许匿名老人之外的所有老人访问 |
XduaApiRoles |
Zoon |
只要登录就可以创建老人 |
XduaApiResource |
user |
|
XduaApiKparam |
id |
|
XduaApiAction |
RecycleUser |
|
XduaApiRule |
RecycleUser |
|
XduaApiAstates |
0 |
按序user,zone,corp,shop,user,user,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable |
true |
接口使能 |
请求参数
名称 |
位置 |
类型 |
必填 |
默认值 |
示例 |
说明 |
id |
path |
string |
是 |
|
rYub4wrT |
要删除的老人ID |
返回参数
名称 |
位置 |
类型 |
示例 |
说明 |
id |
result |
string |
rYub4wrT |
删除的老人ID |
错误码