Appearance
简介
1、邮箱注册
用户注册接口,注册成功返回uid
POST接口
数据类型 "Content-Type": "application/x-www-form-urlencoded"
https://pro.bemfa.com/v1/register
参数 | 是否必须 | 说明 |
---|---|---|
是 | 用户注册邮箱 | |
password | 是 | 用户注册密码 |
ad | 否 | 管理员admin ID |
ad字段说明:获取管理员ID方法见5.18节,如果携带此字段,会自动将该新账号绑定下管理员账号下。
正常响应:
{
"code": 0,
"message": "OK",
"data": "7d54f85af42976ee3c2693e692a6bb59"
}
data 字段为用户私钥。
code 字段说明:
状态码 | 说明 |
---|---|
0 | 成功 |
10002 | 请求参数有误 |
20103 | 用户已存在 |
40000 | 未知错误 |
40007 | 请求次数过多 |
2、邮箱登录
用户登录,登录成功返回uid
POST接口
数据类型 "Content-Type": "application/x-www-form-urlencoded"
https://pro.bemfa.com/v1/login
参数 | 是否必须 | 说明 |
---|---|---|
是 | 用户登录邮箱 | |
password | 是 | 用户登录密码 |
正常响应:
{
"code": 0,
"message": "OK",
"data": "7d54f85af42976ee3c2693e692a6bb59"
}
data 字段为用户私钥
code 字段说明:
状态码 | 说明 |
---|---|
0 | 成功 |
10002 | 请求参数有误 |
20102 | 用户不存在 |
40000 | 未知错误 |
40007 | 请求次数过多 |
40008 | 密码错误 |
一分钟内登录密码错误6次会触发登录保护,一分钟后解封
3、修改密码
暂未开放。
4、手机注册
JSON格式 数据类型 "Content-Type": "application/json; charset=utf-8
POST接口
https://apis.bemfa.com/vb/api/v1/userRegister
参数 | 是否必须 | 说明 |
---|---|---|
phone | 是 | 手机号,字符串类型 |
password | 是 | 密码,字符串类型6<=X<=32 |
area | 否 | 手机区号,字符串类型,默认86 |
请求体示例:
{
"phone":"133xxxxxxxx",
"password":"xxxxxx"
}
正确返回:
{
"code": 0,
"msg": "success",
"data": {
"code": 0,
"msg": "",
"uid": "04740180bf0944159fc857aafb004314"
}
}
参数 | 说明 |
---|---|
code | 0表示成功 |
uid | 用户私钥 |
5、手机登录
JSON格式 数据类型 "Content-Type": "application/json; charset=utf-8
POST接口
https://apis.bemfa.com/vb/api/v1/userLogin
参数 | 是否必须 | 说明 |
---|---|---|
phone | 是 | 手机号,字符串类型 |
password | 是 | 密码,字符串类型6<=X<=32 |
area | 否 | 手机区号,字符串类型,默认86 |
请求体示例:
{
"phone":"133xxxxxxxx",
"password":"xxxxxx"
}
正确返回:
{
"code": 0,
"msg": "success",
"data": {
"code": 0,
"msg": "",
"uid": "7801e4ba1bf7406593d47250797860fd"
}
}
参数 | 说明 |
---|---|
code | 0表示成功 |
uid | 用户私钥 |
6、设置新的AppID和secretKey
接口说明:如果调用成功,系统会生成新的新的AppID和secretKey,旧的AppID和secretKey不会失效。
JSON格式 数据类型 "Content-Type": "application/json; charset=utf-8
POST接口
https://pro.bemfa.com/vs/web/v1/userSecretKey
参数 | 是否必须 | 类型 | 说明 |
---|---|---|---|
openID | 是 | 字符串类型 | 用户私钥 |
请求体示例:
{
"openID":"7801e4ba1bf7406593d47250797860fd"
}
正确返回:
{
"code": 0,
"msg": "success",
"data": {
"appID": "beid_xQjMwcjN0EzNx8VM3UDN3A",
"secretKey": "7IoRBu2g4kSMywplr9ihofJz4n90HsW9"
}
}
参数 | 类型 | 说明 |
---|---|---|
appID | 字符串 | appID |
secretKey | 字符串 | secretKey |
7、获取所有appID
GET接口
https://pro.bemfa.com/vs/web/v1/userAppID
参数 | 是否必须 | 类型 | 说明 |
---|---|---|---|
openID | 是 | 字符串类型 | 用户私钥 |
正确返回:
{
"code": 0,
"msg": "success",
"data": {
"appIDs": [
"beid_xQjMwcjN0EzNx8VM3UDN3A",
"beid_2IzNwcjN0EzNx8VM3UDN3A",
"beid_3IzNwcjN0EzNx8VM3UDN3A"
]
}
}
参数 | 类型 | 说明 |
---|---|---|
appIDs | 字符串数组 | appID |
8、删除appID
JSON格式 数据类型 "Content-Type": "application/json; charset=utf-8
POST接口
https://pro.bemfa.com/vs/web/v1/userDeleteKey
参数 | 是否必须 | 类型 | 说明 |
---|---|---|---|
openID | 是 | 字符串类型 | 用户私钥 |
appID | 是 | 字符串类型 | appID |
请求体示例:
{
"openID":"7801e4ba1bf7406593d47250797860fd",
"appID":"beid_xcTN0cD"
}
正确返回:
{
"code": 0,
"msg": "success",
"data": {
"code": 0
}
}
参数 | 类型 | 说明 |
---|---|---|
code | 整形 | 0删除成功 |