Appearance
用户接口
本文档介绍巴法云用户相关的API接口，包括邮箱/手机注册登录、密钥管理、appID管理等功能。
邮箱注册
用户注册接口，注册成功返回用户私钥（uid）。
接口信息
- 方法:
POST - URL:
https://apis.bemfa.com/vb/api/v1/emailLogin - Content-Type:
application/json; charset=utf-8
请求参数
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| string | 是 | 用户注册邮箱 | |
| password | string | 是 | 用户注册密码 |
| secretID | string | 否 | API秘钥ID，认证后获取 立即认证 |
| secretKey | string | 否 | API秘钥 ，认证后获取 立即认证 |
请求示例
json
{
"email": "133xxxxxxx@qq.com",
"password": "xxxxxx"
}响应示例
json
{
"code": 0,
"message": "OK",
"data": "7d54f85af42976ee3c2693e692a6bb59"
}响应说明
data字段为用户私钥（uid）
状态码说明
| 状态码 | 说明 |
|---|---|
| 0 | 成功 |
| 10002 | 请求参数有误 |
| 20103 | 用户已存在 |
| 40000 | 未知错误 |
| 40007 | 请求次数过多 |
邮箱登录
用户登录接口，登录成功返回用户私钥（uid）。
接口信息
- 方法:
POST - URL:
https://apis.bemfa.com/vb/api/v1/emailRegister - Content-Type:
application/json; charset=utf-8
请求参数
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| string | 是 | 用户登录邮箱 | |
| password | string | 是 | 用户登录密码 |
| secretID | string | 否 | API秘钥ID，认证后获取 立即认证 |
| secretKey | string | 否 | API秘钥 ，认证后获取 立即认证 |
请求示例
json
{
"email": "133xxxxxxx@qq.com",
"password": "xxxxxx"
}响应示例
json
{
"code": 0,
"message": "OK",
"data": "7d54f85af42976ee3c2693e692a6bb59"
}响应说明
data字段为用户私钥（uid）
状态码说明
| 状态码 | 说明 |
|---|---|
| 0 | 成功 |
| 10002 | 请求参数有误 |
| 20102 | 用户不存在 |
| 40000 | 未知错误 |
| 40007 | 请求次数过多 |
| 40008 | 密码错误 |
注意
一分钟内登录密码错误6次会触发登录保护，一分钟后自动解封。
修改密码
提示
该功能暂未开放。
手机注册
手机号注册接口，注册成功返回用户私钥（uid）。
接口信息
- 方法:
POST - URL:
https://apis.bemfa.com/vb/api/v1/userRegister - Content-Type:
application/json; charset=utf-8
请求参数
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| phone | string | 是 | 手机号 |
| password | string | 是 | 密码，长度6-32位 |
| area | string | 否 | 手机区号，默认86 |
| secretID | string | 否 | API秘钥ID，认证后获取 立即认证 |
| secretKey | string | 否 | API秘钥 ，认证后获取 立即认证 |
请求示例
json
{
"phone": "133xxxxxxxx",
"password": "xxxxxx"
}响应示例
json
{
"code": 0,
"msg": "success",
"data": {
"code": 0,
"msg": "",
"uid": "04740180bf0944159fc857aafb004314"
}
}响应说明
| 参数 | 说明 |
|---|---|
| code | 0表示成功 |
| uid | 用户私钥 |
手机登录
手机号登录接口，登录成功返回用户私钥（uid）。
接口信息
- 方法:
POST - URL:
https://apis.bemfa.com/vb/api/v1/userLogin - Content-Type:
application/json; charset=utf-8
请求参数
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| phone | string | 是 | 手机号 |
| password | string | 是 | 密码，长度6-32位 |
| area | string | 否 | 手机区号，默认86 |
| secretID | string | 否 | API秘钥ID，认证后获取 立即认证 |
| secretKey | string | 否 | API秘钥 ，认证后获取 立即认证 |
请求示例
json
{
"phone": "133xxxxxxxx",
"password": "xxxxxx"
}响应示例
json
{
"code": 0,
"msg": "success",
"data": {
"code": 0,
"msg": "",
"uid": "7801e4ba1bf7406593d47250797860fd"
}
}响应说明
| 参数 | 说明 |
|---|---|
| code | 0表示成功 |
| uid | 用户私钥 |
设置新的AppID和SecretKey
仅用于MQTT连接使用
生成新的AppID和SecretKey。调用成功后，系统会生成新的AppID和SecretKey，旧的密钥不会失效。
接口信息
- 方法:
POST - URL:
https://pro.bemfa.com/vs/web/v1/userSecretKey - Content-Type:
application/json; charset=utf-8
请求参数
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| openID | string | 是 | 用户私钥 |
请求示例
json
{
"openID": "7801e4ba1bf7406593d47250797860fd"
}响应示例
json
{
"code": 0,
"msg": "success",
"data": {
"appID": "beid_xQjMwcjN0EzNx8VM3UDN3A",
"secretKey": "7IoRBu2g4kSMywplr9ihofJz4n90HsW9"
}
}响应说明
| 参数 | 类型 | 说明 |
|---|---|---|
| appID | string | 应用ID |
| secretKey | string | 应用密钥 |
获取所有AppID
获取用户所有的AppID列表。
接口信息
- 方法:
GET - URL:
https://pro.bemfa.com/vs/web/v1/userAppID
请求参数
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| openID | string | 是 | 用户私钥 |
响应示例
json
{
"code": 0,
"msg": "success",
"data": {
"appIDs": [
"beid_xQjMwcjN0EzNx8VM3UDN3A",
"beid_2IzNwcjN0EzNx8VM3UDN3A",
"beid_3IzNwcjN0EzNx8VM3UDN3A"
]
}
}响应说明
| 参数 | 类型 | 说明 |
|---|---|---|
| appIDs | string[] | AppID列表 |
删除AppID
删除指定的AppID。
接口信息
- 方法:
POST - URL:
https://pro.bemfa.com/vs/web/v1/userDeleteKey - Content-Type:
application/json; charset=utf-8
请求参数
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| openID | string | 是 | 用户私钥 |
| appID | string | 是 | 要删除的AppID |
请求示例
json
{
"openID": "7801e4ba1bf7406593d47250797860fd",
"appID": "beid_xcTN0cD"
}响应示例
json
{
"code": 0,
"msg": "success",
"data": {
"code": 0
}
}响应说明
| 参数 | 类型 | 说明 |
|---|---|---|
| code | number | 0表示删除成功 |