接口路径(新):http://hd215.api.yesapi.cn/api/App/User/Register
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.Register
接口描述: 热门 进行新用户注册,创建一个新的会员账号,注册密码需要使用md5后的密码。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
username | 字符串 | 必须 | 最小:1;最大:50 | 注册成为应用的会员账号,注册后不可修改。 | |
password | 字符串 | 必须 | 最小:32;最大:32 | MD5后的密码,须md5后传递,保持全部小写,MD5加密工具 | |
ext_info | 字符串JSON格式 | 可选 | 注册时的用户扩展信息,注册后可修改,需要JSON编码后传递。格式:ext_info={"扩展字段名":"值"},可以同时更新多个字段。JSON在线解析及格式化验证 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.User.Register&username=dogstar&password=e10adc3949ba59abbe56e057f20f883e&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"uuid": "D1B17A85D3D0A38606359115BD01EFEC"
},
"msg": ""
}
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$rs = OkayApiClient::request('App.User.Register', array('username' => '小白','password'=>'ba8c8eef2ce4a75eb264485baabbf6ae'));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[uuid] => E7FA3ED38345FBD3367711E61FE4E2FC
)
[msg] => 小白开放接口:App.User.Register
)
*/
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0注册成功,1已注册,-1可用注册人数已用完 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.uuid | 字符串 | 全局唯一UUID,全局唯一用户ID,注册成功时返回 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/RegisterExt
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.RegisterExt
接口描述: 热门 进行新用户注册,创建一个新的会员账号。区别在于:本接口支持使用原始密码注册。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
username | 字符串 | 必须 | 最小:1;最大:50 | 注册成为应用的会员账号,注册后不可修改。 | |
password | 字符串 | 必须 | 最小:1 | 原始密码 | |
ext_info | 字符串JSON格式 | 可选 | 注册时的用户扩展信息,注册后可修改,需要JSON编码后传递。格式:ext_info={"扩展字段名":"值"},可以同时更新多个字段。JSON在线解析及格式化验证 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0注册成功,1已注册,-1可用注册人数已用完 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.uuid | 字符串 | 全局唯一UUID,全局唯一用户ID,注册成功时返回 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/Login
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.Login
接口描述: 热门 根据账号和md5后的密码进行会员登录
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
username | 字符串 | 必须 | 最小:1;最大:50 | 会员账号,开发者应用的会员,非开发者自己账号。进入会员列表可查看自己的应用会员。 | |
password | 字符串 | 必须 | 最小:32;最大:32 | MD5后的密码,须md5后传递,保持全部小写,MD5加密工具 | |
is_allow_many | 布尔型 | 可选 | true | 是否允许多设备同时登录,true/yes/1 表示:是,false/no/0 表示:否,不允许时会注销已登录的会话状态。 | |
client | 字符串 | 可选 | 最大:30 | 客户端,可用于纪录登录时的设备、版本或应用信息 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.User.Login&username=xxx&password={md5后的密码}&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"uuid": "6C227C5775E547105BBD3D49756C850A",
"token": "7AFD8AFB86C3651E14228CAE1EA5E462C8148199C8ED860BE7B12890D08090E7"
},
"msg": ""
}
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$rs = OkayApiClient::request('App.User.Login', array('username' => 'AAA','password'=>'ba8c8eef2ce4a75eb264485baabbf6ae'));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[uuid] => 5DDC99652BE5C698411400CC693802A1
[token] => A6AEF88DC84DF8E01B992E9756CCAE49C9403D2B0FC1588A7617FF64235DA9CF
)
[msg] => 小白开放接口:App.User.Login
)
*/
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0登录成功,1登录失败,账号不存在;2登录失败,密码错误;3会员已过期,请联系管理员或开发者;4账号已被封号 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.uuid | 字符串 | 全局唯一UUID,全局唯一用户ID |
data.token | 字符串 | 登录凭证,一个月内有效(30天)。如果需要设置更长或更短的有效时间,可提交工单。 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/LoginExt
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.LoginExt
接口描述: 热门 根据账号密码进行会员登录。区别在于:本接口支持使用原始密码注册。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
username | 字符串 | 必须 | 最小:1;最大:50 | 会员账号,开发者应用的会员,非开发者自己账号。进入会员列表可查看自己的应用会员。 | |
password | 字符串 | 必须 | 最小:1 | 原始密码 | |
is_allow_many | 布尔型 | 可选 | true | 是否允许多设备同时登录,true/yes/1 表示:是,false/no/0 表示:否,不允许时会注销已登录的会话状态。 | |
client | 字符串 | 可选 | 最大:30 | 客户端,可用于纪录登录时的设备、版本或应用信息 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.User.LoginExt&username=test&password=123456&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"uuid": "D4986F256D852B101BC2C186D1202A0D",
"token": "E7D5A485F50E3A0E35C2AFEBF12209EB4CB9795D0939E89595329F7394E2B72F",
"role": "user"
},
"msg": "V2.1.1 果创云开放接口 App.User.LoginExt"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0登录成功,1登录失败,账号不存在;2登录失败,密码错误;3会员已过期,请联系管理员或开发者;4账号已被封号 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.uuid | 字符串 | 全局唯一UUID,全局唯一用户ID |
data.token | 字符串 | 登录凭证,一个月内有效(30天)。如果需要设置更长或更短的有效时间,可提交工单。 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/Check
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.Check
接口描述: 常用 检测用户的登录状态
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 必须 | 最小:32;最大:32 | UUID,全局唯一用户ID | |
token | 字符串 | 必须 | 最小:64;最大:64 | 会话凭证 | |
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
|
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.User.Check&uuid=6C227C5775E547105BBD3D49756C850A&token=7550CABB8135AE8726D65F41E7279E616B77971FAA9AB9D2A212A50CEF69EFD1&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": ""
},
"msg": ""
}
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$uuid='E7FA3ED38345FBD3367711E61FE4E2FC';
$token='66493A11E1EB97BA438023527F93CFB35AABBF5DB0386F1EBCF76266080B13A7';
$rs = OkayApiClient::request('App.User.Check', array('uuid' =>$uuid ,'token'=>$token));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
)
[msg] => 小白开放接口:App.User.Check
)
*/
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0已登录,1未登录,或登录态已过期 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/Logout
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.Logout
接口描述: 改 根据UUID和登录token,仅退出当前登录。注意,非登录全部登录。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 必须 | 最小:32;最大:32 | UUID,全局唯一用户ID | |
token | 字符串 | 必须 | 最小:64;最大:64 | 会话凭证 | |
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
|
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/LogoutAll
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.LogoutAll
接口描述: 改 根据UUID。清空指定会员已有的全部登录会话。即此接口一旦调用后,全部登录都会失效,包括当前登录。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 必须 | 最小:32;最大:32 | UUID,全局唯一用户ID | |
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
|
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/Profile
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.Profile
接口描述: 查 获取用户自己的账号/昵称、注册时间以及是否为管理员、扩展信息等信息
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 必须 | 最小:32;最大:32 | UUID,全局唯一用户ID | |
token | 字符串 | 必须 | 最小:64;最大:64 | 会话凭证 | |
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
|
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.User.Profile&uuid=6C227C5775E547105BBD3D49756C850A&token=7AFD8AFB86C3651E14228CAE1EA5E462C8148199C8ED860BE7B12890D08090E7&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"info": {
"uuid": "6C227C5775E547105BBD3D49756C850A",
"username": "test",
"role": "user",
"rolename": "普通会员",
"register_time": "2017-11-10 22:39:15",
"register_ip": "120.25.156.74",
"ext_info": {
"nickname": "dogstar",
"age": 19
}
}
},
"msg": ""
}
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$uuid='E7FA3ED38345FBD3367711E61FE4E2FC';
$token='66493A11E1EB97BA438023527F93CFB35AABBF5DB0386F1EBCF76266080B13A7';
$rs = OkayApiClient::request('App.User.Profile', array('uuid' => $uuid,'token'=>$token));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[info] => Array
(
[uuid] => E7FA3ED38345FBD3367711E61FE4E2FC
[username] => 小白
[role] => user
[rolename] => 管理员
[register_time] => 2019-02-02 22:24:18
[register_ip] => 120.229.171.203
[ext_info] => Array ( )
)
)
[msg] => 小白开放接口:App.User.Profile
)
*/
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0正常获取,1用户不存在,或者已被封号 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.info.uuid | 字符串 | 全局唯一UUID,全局唯一用户ID,注册成功时返回 |
data.info.username | 字符串 | 账号/昵称 |
data.info.role | 字符串 | 用户角色(user/admin) |
data.info.rolename | 字符串 | 用户角色说明(普通用户/管理员) |
data.info.register_time | 字符串 | 注册时间,示例:2018-01-20 15:00:00 |
data.info.register_ip | 字符串 | 注册IP,示例:192.168.1.1 |
data.info.ext_info | 对象 | 用户扩展信息,开发者可以自定义存放更多用户信息,如:昵称、头像、年龄、性别等。以yesapi_开头的扩展字段,属于小白开放平台维护的信息。其中,yesapi_avatar是会员头像链接,yesapi_avatar_https则表示HTTPS的头像链接(不支持时为空)。 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/OtherProfile
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.OtherProfile
接口描述: 查 获取其他用户的账号/昵称、注册时间以及是否为管理员、扩展信息等信息
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
other_uuid | 字符串 | 必须 | 最小:32;最大:32 | UUID,全局唯一用户ID |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0正常获取,1用户不存在,或者已被封号 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.info.uuid | 字符串 | 全局唯一UUID,全局唯一用户ID,注册成功时返回 |
data.info.username | 字符串 | 账号/昵称 |
data.info.role | 字符串 | 用户角色(user/admin) |
data.info.rolename | 字符串 | 用户角色说明(普通用户/管理员) |
data.info.status | 整型 | 会员状态,0正常1已封号 |
data.info.register_time | 字符串 | 注册时间,示例:2018-01-20 15:00:00 |
data.info.register_ip | 字符串 | 注册IP,示例:192.168.1.1 |
data.info.ext_info | 对象 | 用户扩展信息,开发者可以自定义存放更多用户信息,如:昵称、头像、年龄、性别等 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/MultiProfile
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.MultiProfile
接口描述: 查 根据多个UUID,批量获取会员信息
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
uuids | 字符串用,分割 | 必须 | 最小:1;最大:500 | 多个UUID,使用英文逗号分割 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.User.MultiProfile&uuid=F6B6A9FABF5A7241B423BA3160371250&token=2A6B1D1017353E77B1B57537F554364F79468602A60D6E24F2D5C84B16592057&uuids=E960DE16AD68A9DC2DAF2EE2EECEF9BD,438D09AFAAF599A919E02BA600C5A97A,F6B6A9FABF5A7241B423BA3160371250&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"info_list": [
{
"uuid": "E960DE16AD68A9DC2DAF2EE2EECEF9BD",
"username": "张三",
"role": "user",
"rolename": "普通会员",
"register_time": "2019-08-01 22:08:35",
"register_ip": "",
"ext_info": {
"yesapi_avatar": "",
"nickname": "",
"age": "18"
}
},
{
"uuid": "F6B6A9FABF5A7241B423BA3160371250",
"username": "李四",
"role": "user",
"rolename": "普通会员",
"register_time": "2019-10-04 20:40:03",
"register_ip": "",
"ext_info": {
"yesapi_avatar": "",
"nickname": "",
"age": "18"
}
},
{
"uuid": "438D09AFAAF599A919E02BA600C5A97A",
"username": "王五",
"role": "user",
"rolename": "普通会员",
"register_time": "2019-10-04 21:04:02",
"register_ip": "",
"ext_info": {
"yesapi_avatar": "",
"nickname": "",
"age": "18"
}
}
]
},
"msg": "小白开放接口:App.User.MultiProfile"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.info_list | 字符串 | 会员信息列表,没有任何会员信息时返回空数组。若指定的UUID未找到,则不返回任何数据。 |
data.info_list[].uuid | 字符串 | 全局唯一UUID,全局唯一用户ID,注册成功时返回 |
data.info_list[].username | 字符串 | 账号/昵称 |
data.info_list[].role | 字符串 | 用户角色(user/admin) |
data.info_list[].rolename | 字符串 | 用户角色说明(普通用户/管理员) |
data.info_list[].register_time | 字符串 | 注册时间,示例:2018-01-20 15:00:00 |
data.info_list[].register_ip | 字符串 | 注册IP,示例:192.168.1.1 |
data.info_list[].ext_info | 对象 | 用户扩展信息,开发者可以自定义存放更多用户信息,如:昵称、头像、年龄、性别等 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/UpdateExtInfo
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.UpdateExtInfo
接口描述: 改 开发者可以自定义存放更多用户信息,如:昵称、头像、年龄、性别等。当更新的信息不存在时,则会先添加。请注意,只支持一层扩展信息。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 必须 | 最小:32;最大:32 | UUID,全局唯一用户ID | |
token | 字符串 | 必须 | 最小:64;最大:64 | 会话凭证 | |
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
ext_info | 字符串JSON格式 | 必须 | 待更新的用户扩展信息,需要JSON编码后传递。格式:ext_info={"扩展字段名":"值"},可以同时更新多个字段。JSON在线解析及格式化验证 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.User.UpdateExtInfo&uuid=6C227C5775E547105BBD3D49756C850A&token=7AFD8AFB86C3651E14228CAE1EA5E462C8148199C8ED860BE7B12890D08090E7&ext_info={"location":"广州"}&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"ext_info": {
"nickname": "dogstar",
"age": 19,
"location": "广州"
}
},
"msg": ""
}
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$uuid='E7FA3ED38345FBD3367711E61FE4E2FC';
$token='66493A11E1EB97BA438023527F93CFB35AABBF5DB0386F1EBCF76266080B13A7';
$rs = OkayApiClient::request('App.User.UpdateExtInfo', array('key'=>'character','uuid'=>$uuid,'token'=>$token,'ext_info'=>json_encode(array("age"=>19,"location"=>"广州"))));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[ext_info] => Array
(
[age] => 19
[location] => 广州
)
)
[msg] => 小白开放接口:App.User.UpdateExtInfo
)
*/
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0更新成功,1用户不存在,或者已被封号 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.ext_info | 对象 | 成功更新后的用户扩展信息,以便核对 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/UpdateExtInfoForAdmin
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.UpdateExtInfoForAdmin
接口描述: 改 开发者可以自定义存放更多用户信息,如:昵称、头像、年龄、性别等。当更新的信息不存在时,则会先添加。请注意,只支持一层扩展信息。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 必须 | 最小:32;最大:32 | UUID,全局唯一用户ID,被修改扩展信息的用户ID | |
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
admin_uuid | 字符串 | 必须 | 最小:32;最大:32 | 管理员的UUID,需要先在小白开放平台-会员列表-角色设置-角色-管理员,设置用户为管理员,然后传入用户的UUID | |
admin_token | 字符串 | 必须 | 最小:64;最大:64 | 管理员的会话凭证,确保你是管理员。 | |
ext_info | 字符串JSON格式 | 必须 | 待更新的用户扩展信息,需要JSON编码后传递。格式:ext_info={"扩展字段名":"值"},可以同时更新多个字段。JSON在线解析及格式化验证 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0更新成功,1用户不存在,或者已被封号 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.ext_info | 对象 | 成功更新后的用户扩展信息,以便核对 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/GetList
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.GetList
接口描述: 查 获取已注册的会员列表
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
page | 整型 | 可选 | 1 | 第几页 | |
perpage | 整型 | 可选 | 20 | 最大:1000 | 分页数量 |
role | 字符串 | 可选 | all | 管理员为"admin"用户为"user"全部为"all" | |
sort_type | 整型 | 可选 | 1 | 1注册时间降序,2注册时间升序,3账号名降序,4账号名升序 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.User.GetList&page=1&perpage=20&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"users": [
{
"uuid": "D1B17A85D3D0A38606359115BD01EFEC",
"username": "dogstar",
"role": "admin",
"role_desc": "管理员",
"status": 0,
"status_desc": "正常",
"reg_time": "2018-06-28 22:03:22",
"ext_info": {
}
},
{
"uuid": "6C227C5775E547105BBD3D49756C850A",
"username": "test",
"role": "user",
"role_desc": "普通会员",
"status": 1,
"status_desc": "已封号",
"reg_time": "2017-11-10 22:39:15",
"ext_info": {
"nickname": "dogstar",
"age": 19,
"location": "广州"
}
}
],
"total": 2
},
"msg": "当前请求接口:App.User.GetList"
}
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$rs = OkayApiClient::request('App.User.GetList');
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[users] => Array
(
[0] => Array
(
[uuid] => E7FA3ED38345FBD3367711E61FE4E2FC
[username] => 小白
[role] => user
[role_desc] => 管理员
[status] => 0
[status_desc] => 正常
[reg_time] => 2019-02-02 22:24:18
[ext_info] => Array ( )
)
[1] =>Array
(
[uuid] => 5DDC99652BE5C698411400CC693802A1
[username] => AAA
[role] => user
[role_desc] => 普通用户
[status] => 0
[status_desc] => 正常
[reg_time] => 2019-02-02 20:00:00
[ext_info] => Array ( )
)
[2] =>Array
(
[uuid] => A5EA893548E493A0ABD6F64978AAA773
[username] => 123123
[role] => user
[role_desc] => 普通用户
[status] => 0
[status_desc] => 正常
[reg_time] => 2019-02-02 17:35:59
[ext_info] => Array ( )
)
)
[total] => 3
)
[msg] => 小白开放接口:App.User.GetList
)
*/
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.users | 字符串 | 会员列表 |
data.users[].uuid | 字符串 | 会员UUID |
data.users[].username | 字符串 | 会员账号 |
data.users[].role | 字符串 | 会员角色,admin是管理员,user是普通用户 |
data.users[].role_desc | 字符串 | 会员角色说明 |
data.users[].status | 整型 | 会员状态,0正常,1已被封号 |
data.users[].status_desc | 字符串 | 会员状态说明 |
data.users[].reg_time | 字符串 | 注册时间 |
data.users[].ext_info | 对象 | 通过修改用户扩展信息接口修改的特定会员扩展信息,通过默认会员扩展信息配置可以设置默认扩展信息。 |
data.total | 整型 | 会员总数 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/AlterPassword
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.AlterPassword
接口描述: 改 根据原密码,修改账号登录新密码
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
username | 字符串 | 必须 | 最小:1;最大:50 | 会员账号,开发者应用的会员,非开发者自己账号。进入会员列表可查看自己的应用会员。 | |
old_password | 字符串 | 必须 | 最小:32;最大:32 | 原密码,须md5后传递,保持全部小写 | |
new_password | 字符串 | 必须 | 最小:32;最大:32 | 新密码,须md5后传递,保持全部小写 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$old_password='ba8c8eef2ce4a75eb264485baabbf6ae';
$new_password='864a89eec3618a7ed00a6e2b881f7c3d';
$rs = OkayApiClient::request('App.User.AlterPassword', array('username'=>'小白','old_password'=>$old_password,'new_password'=>$new_password));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
)
[msg] => 小白开放接口:App.User.AlterPassword
)
*/
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0修改成功,1密码修改失败,原密码错误或账号不存在;2密码修改失败,不能与原来密码相同 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/ResetPasswordForAdmin
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.ResetPasswordForAdmin
接口描述: 改 重置会员密码,不需要原来密码,但需要任意一位管理员登录态。并且出于于安全考虑,此接口不能重置任何管理员的密码,如需重置,请登录小白开放平台人工操作。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
username | 字符串 | 必须 | 最小:1;最大:50 | 会员账号,开发者应用的会员,非开发者自己账号。进入会员列表可查看自己的应用会员。 | |
new_password | 字符串 | 必须 | 最小:32;最大:32 | 新密码,须md5后传递,保持全部小写 | |
admin_uuid | 字符串 | 必须 | 最小:32;最大:32 | 管理员的UUID,需要先在小白开放平台-会员列表-角色设置-角色-管理员,设置用户为管理员,然后传入用户的UUID | |
admin_token | 字符串 | 必须 | 最小:64;最大:64 | 管理员的会话凭证,确保你是管理员。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.User.ResetPasswordForAdmin&username=xxx&new_password={md5后的密码}&admin_uuid=D1B17A85D3D0A38606359115BD019FEC&admin_token=0D51036A8C91EFE34A4AE49D068E6F1495CB16692CBEEE43AAFE33E2B4B9D76C&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": ""
},
"msg": ""
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0修改成功;1密码修改失败,不能与原来密码相同,或账号不存在;2出于安全考虑,不能重置任何管理员密码 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/RemoveUserForAdmin
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.RemoveUserForAdmin
接口描述: 删危险 根据uuid删除会员,注意!会员一旦删除,不可恢复!请谨慎调用!需要管理员权限。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
other_uuid | 字符串 | 必须 | 最小:32;最大:32 | 需要删除的会员uuid,注意!一旦删除,不可恢复! | |
admin_uuid | 字符串 | 必须 | 最小:32;最大:32 | 管理员的UUID,需要先在小白开放平台-会员列表-角色设置-角色-管理员,设置用户为管理员,然后传入用户的UUID | |
admin_token | 字符串 | 必须 | 最小:64;最大:64 | 管理员的会话凭证,确保你是管理员。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0删除成功,1非管理员,2不能删除自己,3不能删除其他管理员 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/BanUserForAdmin
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.BanUserForAdmin
接口描述: 改 进行会员账号解封或封号处理。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
user_status | 整型 | 必须 | 最小:0;最大:1 | 需要设置的状态,1是解封账号,0是封禁账号。 | |
other_uuid | 字符串 | 必须 | 最小:32;最大:32 | 需要解封或封号的会员uuid, | |
admin_uuid | 字符串 | 必须 | 最小:32;最大:32 | 管理员的UUID,需要先在小白开放平台-会员列表-角色设置-角色-管理员,设置用户为管理员,然后传入用户的UUID | |
admin_token | 字符串 | 必须 | 最小:64;最大:64 | 管理员的会话凭证,确保你是管理员。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0成功,1非管理员,2不能解封/封号自己 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.user_status | 整型 | 最新状态,0已被封号,1正常使用 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/Search
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.Search
接口描述: 查 模糊搜索会员账号,最多返回前面100个搜索结果。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
username | 字符串 | 可选 | 需要搜索的应用会员账号,支持模糊搜索 | ||
ext_info_str | 字符串 | 可选 | 会员的扩展信息片段,支持模糊搜索 | ||
num | 整型 | 可选 | 10 | 最小:1;最大:100 | 搜索最新注册的多少位会员 |
page | 整型 | 可选 | 1 | 最小:1 | 第几页 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.User.Search&username=dogstar&num=3&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"users": [
{
"username": "dogstar1569080514",
"uuid": "201E693A2EC1EBF029D7D59719659630"
},
{
"username": "dogstar1569080441",
"uuid": "066CD4905065CE12123CEDEF1CB7193B"
},
{
"username": "dogstar1568980839",
"uuid": "4B017110191846DC1DD935BBACF02449"
}
]
},
"msg": "小白开放接口:App.User.Search"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.users | 字符串 | 搜索结果,没有时为空数组 |
data.users[].username | 字符串 | 会员账号 |
data.users[].uuid | 字符串 | 会员UUID |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/UploadAvatar
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.UploadAvatar
接口描述: 改 可将待上传的头像图片文件二进制内容进行base64编码后上传。可以修改指定会员的头像,不需要登录态。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
other_uuid | 字符串 | 必须 | 最小:32;最大:32 | UUID,全局唯一用户ID,需要修改的会员uuid | |
file | 字符串 | 必须 | 数据源:POST | 会员头像,此参数必须使用POST方式传递,且必须进行base64编码后传递,对待上传文件二进制内容进行basse64编码后的数据,此部分数据需要纳入签名。格式示例:data:image/gif;base64,R0lGODlhAQABAIAAAHd3dwAAACH5BAAAAAAALAAAAAABAAEAAAICRAEAOw== |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0成功,1头像更新失败 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.yesapi_avatar | 字符串 | 上传成功后的会员头像图片链接。 |
data.yesapi_avatar_https | 字符串 | 上传成功后的会员头像图片HTTPS链接,不支持HTTPS时为空。 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/ChangeRole
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.ChangeRole
接口描述: 改 修改会员的分组,支持自定义分组。此普通版接口只支持普通会员和自定义分组之间的转换和修改,不能修改管理员角色。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
other_uuid | 字符串 | 必须 | 最小:32;最大:32 | UUID,全局唯一用户ID,需要修改的会员uuid | |
new_role | 字符串 | 必须 | 最小:1;最大:10 | 分组名称,user为普通会员,admin为管理员(不能设置),支持自定义分组名称 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作状态码,0成功,1会员不存在或者已被封号,2不能设置管理员,3角色没有变化 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.before_role | 字符串 | 修改之前的角色 |
data.after_role | 字符串 | 修改之后的角色 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/ChangeRoleForAdmin
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.ChangeRoleForAdmin
接口描述: 改 管理员用的,修改会员的分组,支持自定义分组,并且能修改管理员角色。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
other_uuid | 字符串 | 必须 | 最小:32;最大:32 | UUID,全局唯一用户ID,需要修改的会员uuid | |
new_role | 字符串 | 必须 | 最小:1;最大:10 | 分组名称,user为普通会员,admin为管理员(可以设置),支持自定义分组名称 | |
admin_uuid | 字符串 | 必须 | 最小:32;最大:32 | 管理员的UUID,需要先在小白开放平台-会员列表-角色设置-角色-管理员,设置用户为管理员,然后传入用户的UUID | |
admin_token | 字符串 | 必须 | 最小:64;最大:64 | 管理员的会话凭证,确保你是管理员。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作状态码,0成功,1不是管理员,2不能修改自己的角色 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/FastGetUserLongList
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.FastGetUserLongList
接口描述: 查 获取用户下拉列表数据,最多支持1万名,只返回username和uuid,方便作为待选择的账号下拉菜单,按用户名进行排序。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
page | 整型 | 可选 | 1 | 第几页 | |
perpage | 整型 | 可选 | 100 | 最大:10000 | 分页数量 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.User.FastGetUserLongList&page=1&perpage=5&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"users": [
{
"uuid": "6C227C5775E547105BBD3D49756C850A",
"username": "test"
},
{
"uuid": "D1B17A85D3D0A38606359115BD01EFEC",
"username": "dogstar"
},
{
"uuid": "91A6EE6E73FA097ECD5FD6CC4BCFB62B",
"username": "张三"
},
{
"uuid": "3B0D2B2DC125272A1EE9764525F0663E",
"username": "李四"
},
{
"uuid": "A3FA460B82D965B40DCC7E01BF20CB4E",
"username": "老王"
}
]
},
"msg": "小白开放接口:App.User.FastGetUserLongList"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.users | 字符串 | 用户列表,没有时返回空数组 |
data.users[].username | 字符串 | 会员账号 |
data.users[].uuid | 字符串 | 会员UUID |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/SendResetPasswordEmailCode
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.SendResetPasswordEmailCode
接口描述: 通过会员邮箱找回密码接口。首先,会员扩展信息中必须已经包含会员的邮箱地址,否则无法发送;其次,开发者必须已正确配置并开启邮件服务,否则无法发送;最后,邮件发送成功后需要调用App.User.ResetPasswordWithEmailCode会员邮箱重置密码接口。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
username | 字符串 | 必须 | 最小:1 | 需要找回密码的应用会员账号 | |
email_field | 字符串 | 可选 | yesapi_email | 会员扩展信息中邮箱的字段名称,且会员的邮箱不能为空 | |
expire_time | 整型 | 可选 | 3600 | 最小:60;最大:3600 | 单位:秒,表示邮件动态验证码多少时间内有效,最短1分钟,最长1小时。 |
code_len | 整型 | 可选 | 6 | 最小:4;最大:8 | 动态验证码的长度,由大小写和数字组成。 |
code_type | 整型 | 可选 | 动态验证码的类型:默认-数字+大小写字母;1-纯数字;2-纯小写字母;3-纯大写字母;4-大小写字母 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s==App.User.SendResetPasswordEmailCode&username=dogstar&email_field=yesapi_email&expire_time=3600&code_len=6&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
},
"msg": ""
}
成功发送邮件后,会收到类似标题为【找回密码动态验证码】的邮件,邮件内容类似如下:
dogstar 您好,
您正在通过邮件找回密码,验证码是 123456 ,请及时使用,60 分钟内有效。
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作状态码,0成功,1会员不存在,2员邮箱为空或邮箱地址非法,3邮件动态验证码已发送 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/ResetPasswordWithEmailCode
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.ResetPasswordWithEmailCode
接口描述: 改 通过App.User.SendResetPasswordEmailCode会员邮箱找回密码接口发送邮件后,把接收到的动态验证码和新密码传递过来,验证后即可重置会员密码。特别注意,为避免被暴力破解,验证码每核对失败一次,有效时间将减少10分钟。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
username | 字符串 | 必须 | 最小:1 | 需要找回密码的应用会员账号 | |
code | 字符串 | 必须 | 邮件里的动态验证码 | ||
new_password | 字符串 | 必须 | 最小:32;最大:32 | 新密码,须md5后传递,保持全部小写 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.User.ResetPasswordWithEmailCode&username=dogstar&code=123456&new_password={md5后的密码}&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
},
"msg": ""
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作状态码,0重置成功,1邮件动态验证码已过期,2验证码不正确,3密码修改失败 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/GetLastestLoginList
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.GetLastestLoginList
接口描述: 查 获取最近30天内成功登录的会员列表
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
num | 整型 | 可选 | 20 | 最大:1000 | 需要返回的会员数量 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s==App.User.GetLastestLoginList&num=3&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"members": [
{
"uuid": "8AEA2AF1951C0376EC668A74B8CAA64A",
"client": "",
"login_time": 1571622302,
"ip": "",
"username": "phpunit",
"role": "user"
},
{
"uuid": "583B1A3DC84964E85E236C7122F59760",
"client": "",
"login_time": 1557928673,
"ip": "",
"username": "富布斯",
"role": "user"
},
{
"uuid": "9A78FBFD650F8DB3C1F17FE3F0865500",
"client": "",
"login_time": 1556939492,
"ip": "",
"username": "test",
"role": "user"
}
]
},
"msg": "小白开放接口:App.User.GetLastestLoginList"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.members | 字符串 | 会员列表,没有时为空数组 |
data.members[].uuid | 字符串 | 会员UUID |
data.members[].client | 字符串 | 会员登录时的客户端,没有时为空字符串 |
data.members[].login_time | 字符串 | 登录时间 |
data.members[].ip | 字符串 | 登录IP,没有时为空字符串 |
data.members[].username | 字符串 | 会员账号 |
data.members[].role | 字符串 | 会员角色,user为普通会员,admin为管理员,其他值为自定义角色 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/RemoveUserBySelf
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.RemoveUserBySelf
接口描述: 删危险 根据uuid删除会员,注意!会员一旦删除,不可恢复!请谨慎调用!注销删除会员账号,会员相关的表单数据,需要另行删除。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 必须 | 最小:32;最大:32 | UUID,全局唯一用户ID | |
token | 字符串 | 必须 | 最小:64;最大:64 | 会话凭证 | |
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
|
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0删除成功 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/SendMessageNotice
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.SendMessageNotice
接口描述: 向用户发送消息通知
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
to_uuid | 字符串 | 必须 | 最小:32;最大:32 | 待接收消息通知的UUID | |
content | 字符串 | 必须 | 需要发送的消息内容,一段内容 | ||
ext_info | 字符串JSON格式 | 可选 | [] | 更多自定义的消息数据。JSON在线解析及格式化验证 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.User.SendMessageNotice&to_uuid=0DA87F2EB766CED20345DAC8D56B3DAD&content=test测试下&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": ""
},
"msg": "V2.5.1 YesApi App.User.SendMessageNotice"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/GetMyMessageNoticeNewNum
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.GetMyMessageNoticeNewNum
接口描述: 获取我的新消息通知(即未读)的数量,需要用户本人已登录。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
|
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.User.GetMyMessageNoticeNewNum&uuid=0DA87F2EB766CED20345DAC8D56B3DAD&token=6F35F5689A1DFD02B61D10508E8179552CFE283F6DF1D4C2A425211F2DE31EB8&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"num": 2
},
"msg": "V2.5.1 YesApi App.User.GetMyMessageNoticeNewNum"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.num | 整型 | 新消息通知数量 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/GetMyMessageNoticeList
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.GetMyMessageNoticeList
接口描述: 获取我的消息通知列表,需要用户本人已登录。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
page | 整型 | 可选 | 1 | 最小:1 | 第几页 |
perpage | 整型 | 可选 | 10 | 最小:1;最大:100 | 分页数量 |
type | 枚举类型 | 可选 | ALL | 范围:ALL/NEW/READ | 消息类型,ALL为全部,NEW为未读,READ为已读 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.User.GetMyMessageNoticeList&uuid=0DA87F2EB766CED20345DAC8D56B3DAD&token=6F35F5689A1DFD02B61D10508E8179552CFE283F6DF1D4C2A425211F2DE31EB8&page=1&perpage=10&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"items": [
{
"data": {
"content": "test测试下"
},
"keyword": "NEW",
"add_time": "2020-06-06 20:15:04"
},
{
"data": {
"content": "test测试下"
},
"keyword": "NEW",
"add_time": "2020-06-06 20:14:38"
}
],
"total": 2
},
"msg": "V2.5.1 YesApi App.User.GetMyMessageNoticeList"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.items | 字符串 | 消息列表 |
data.items[].id | 整型 | 消息ID |
data.items[].data | 对象 | 消息结构体 |
data.total | 整型 | 总数 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/MarkReadMyMessage
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.MarkReadMyMessage
接口描述: 将一条或全部消息通知标志为已读,需要用户本人已登录。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
id | 整型 | 必须 | 0 | 需要标志为已读的消息通知,为0或不传时将全部消息通知标志为已读 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.User.MarkReadMyMessage&uuid=0DA87F2EB766CED20345DAC8D56B3DAD&token=6F35F5689A1DFD02B61D10508E8179552CFE283F6DF1D4C2A425211F2DE31EB8&id=8210&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": ""
},
"msg": "V2.5.1 YesApi App.User.MarkReadMyMessage"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hd215.api.yesapi.cn/api/App/User/ChangeUserPointForAdmin
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.User.ChangeUserPointForAdmin
接口描述: 修改变更会员的积分,可以累加也可以扣除,并返回修改的结果和修改后的最新积分,同时保存 业务日记 以便追查积分变更日记。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
change_point | 整型 | 必须 | 需要变更的会员积分,正数表示累加积分,负数表示扣除积分,注意不要传错 | ||
change_reason | 字符串 | 可选 | 最大:500 | 变更原因,推荐填写,方便追查,控制在300个字符以内。 | |
other_uuid | 字符串 | 必须 | 最小:32;最大:32 | UUID,全局唯一用户ID,需要修改的会员uuid | |
admin_uuid | 字符串 | 必须 | 最小:32;最大:32 | 管理员的UUID,需要先在小白开放平台-会员列表-角色设置-角色-管理员,设置用户为管理员,然后传入用户的UUID | |
admin_token | 字符串 | 必须 | 最小:64;最大:64 | 管理员的会话凭证,确保你是管理员。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
# 添加2个积分
{你的接口域名}/?&=App.User.ChangeUserPointForAdmin&return_data=0&change_point=2&change_reason=测试&other_uuid=732C2BDF4604708B7BBCAE50D101BB80&admin_uuid=D1B17A85D3D0A38606359115BD01EFEC&admin_token=538E4193F0E6CA00BB7F736FA50537FF00250C517A1D2132AE41839C6B96288A
# 成功返回
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"change_point": 2,
"after_change_point": 4
},
"msg": "",
"_t": 1669954989,
"_auth": "6e01450378f64881c41039b58a75e370"
}
# 业务日记类似
https://open.yesapi.cn/?r=Data/CheckLog
会员积分变更成功,UUID:732C2BDF4604708B7BBCAE50D101BB80,本次变更2,修改前:2,修改后:4,修改原因:测试,管理员UUID:D1B17A85D3D0A38606359115BD01EFEC。
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0变更成功,1变更失败,扣除积分时会员剩余积分不够;2会员不存在或已被删除 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.change_point | 整型 | 本次变更的积分 |
data.after_change_point | 整型 | 变更修改后的会员积分 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
特别注意:当前 hd215.api.yesapi.cn 为临时接口测试域名!请先完成 绑定独立接口域名后 ,才能正式进行API调用。
由 果创云YesApi.cn 提供技术支持,4万+开发者都在用,累计API调用1,800,000+万次