1. 创建关注

调用场景

  • 微信小程序上关注一个关注。
  • 养老院后台强制让一个护工关注关注。

请求方式

POST:/care

请求参数

名称 位置 类型 必填 默认值 示例 说明
Authorization head String 使用用户登录后的令牌
carer_id body string ""pGJx3b4A"" 发起关注的用户的id
caree_id body string ""pGJx3b45"" 要关注的用户的id

返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 创建的关注ID

错误码

reason 说明
0 success 成功
200001 CareAlreadyExists 已经关注过了

2. 删除关注

请求参数

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

返回参数

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

错误码


3. 关闭关注

请求参数

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

返回参数

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

错误码


4. 注销关注

描述

软删关注。

请求参数

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

返回参数

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

错误码

5. 激活关注

描述

请求参数

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

返回参数

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

错误码

6. 回收关注

请求参数

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

返回参数

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

错误码

7. 回收关注

描述

回收关注。

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

请求参数

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

返回参数

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

错误码

8. 修改关注

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

返回参数

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

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的关注名",
        "brief":"新的关注介绍",    
    }    
}

错误码

9. 修改关注

描述

修改关注。

调用场景

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

配置参数

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

返回参数

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

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的关注名",
        "brief":"新的关注介绍",    
    }    
}

错误码

10. 查询关注

GET:/care

请求参数

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

字段名 位置 类型 说明 描述 可选
apiv head string API版本,默认是1.0.0 1.0.0 可选
Authorization head string 客户端保存的鉴权token Authorization字符串 必选

返回参数

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

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. 私查关注

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. 私查关注对象

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

请求参数

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

返回参数

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

result.list部分

名称 位置 类型 示例 说明
id result string rYub4wrT 关注ID
carer_id result.list[] string 关注的用户ID
caree_id result.list[] string 被关注的用户ID
XduaUserProfile_name result.list[] string 辣椒帅 关注创建者名字
XduaUserProfile_Gender result.list[] string "f"/"m"/"u" u:未知性别,f:女性,m:男性
XduaUserProfile_Avatar result.list[] string "http://xxx.jpg" 头像URL
cstamp result.list[] string 2020-01-20 02:19:55 创建时间

错误码

13. 详情关注

描述

详情关注。

调用场景

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

配置参数

参数名 参数值 说明
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://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);
}

14. 下线关注

描述

下线关注。

调用场景

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

配置参数

参数意义参考接口参数

参数名 参数值 说明
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

错误码

15. 发布关注

描述

发布关注。

调用场景

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

配置参数

参数意义参考接口参数

参数名 参数值 说明
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

错误码

16. 回收关注

描述

回收关注。

调用场景

管理员应开发者的要求,登录超级控制台后,查询到某个开发者下面的被删除的关注。然后回收。开发者刷新就可以看到了。为此,开发者要提供自己的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

错误码

results matching ""

    No results matching ""