巴法文档中心

Appearance

用户接口 ​

本文档介绍巴法云用户相关的API接口，包括邮箱/手机注册登录、密钥管理、appID管理等功能。在接口中使用企业 API 密钥后，普通用户会自动绑定到该企业。

返回格式说明 ​

注册、登录接口统一返回以下结构：

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "code": 0,
        "msg": "",
        "uid": "7d54f85af42976ee3c2693e692a6bb59"
    }
}

说明：

参数类型说明
codenumber外层请求状态，0表示请求处理成功，-1表示直接返回错误
msgstring外层请求消息
data.codenumber业务状态，0表示成功，负数表示业务失败
data.msgstring业务失败原因
data.uidstring用户私钥，注册或登录成功时返回

参数错误、未知错误、secretID 或 secretKey 错误等会直接返回错误信息：

json
{
    "code": -1,
    "msg": "参数错误",
    "data": ""
}

接口说明 ​

注册、登录、修改密码接口必须传入 secretID 和 secretKey，用于校验调用方身份。旧版接口继续保留，参数和调用方式不变。

注意

接口中 secretID 和 secretKey 均为必填参数，未传或校验失败会返回参数错误或 secretID或secretKey错误。

邮箱注册 ​

用户邮箱注册接口，注册成功返回用户私钥（uid）。

接口信息 ​

  • 方法: POST
  • URL: https://apis.bemfa.com/vb/api/v2/emailRegister
  • Content-Type: application/json; charset=utf-8

请求参数 ​

参数类型是否必须说明
emailstring是用户注册邮箱
passwordstring是用户注册密码，长度6-32位
secretIDstring是企业 API 密钥 ID，认证后获取 立即认证
secretKeystring是企业 API 密钥，认证后获取 立即认证

提示

使用企业 API 密钥后，普通用户会自动绑定到该企业。

请求示例 ​

json
{
    "email": "133xxxxxxx@qq.com",
    "password": "xxxxxx",
    "secretID": "yourSecretID",
    "secretKey": "yourSecretKey"
}

响应示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "code": 0,
        "msg": "",
        "uid": "7d54f85af42976ee3c2693e692a6bb59"
    }
}

响应说明 ​

参数说明
code0表示请求处理成功
data.code0表示注册成功，-2表示邮箱已注册，-3表示邮箱格式错误
data.msg业务失败原因
data.uid用户私钥

邮箱登录 ​

用户邮箱登录接口，登录成功返回用户私钥（uid）。

接口信息 ​

  • 方法: POST
  • URL: https://apis.bemfa.com/vb/api/v2/emailLogin
  • Content-Type: application/json; charset=utf-8

请求参数 ​

参数类型是否必须说明
emailstring是用户登录邮箱
passwordstring是用户登录密码，长度6-32位
secretIDstring是企业 API 密钥 ID，认证后获取 立即认证
secretKeystring是企业 API 密钥，认证后获取 立即认证

提示

使用企业 API 密钥后，普通用户会自动绑定到该企业。

请求示例 ​

json
{
    "email": "133xxxxxxx@qq.com",
    "password": "xxxxxx",
    "secretID": "yourSecretID",
    "secretKey": "yourSecretKey"
}

响应示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "code": 0,
        "msg": "",
        "uid": "7d54f85af42976ee3c2693e692a6bb59"
    }
}

响应说明 ​

参数说明
code0表示请求处理成功
data.code0表示登录成功，-2表示用户不存在，-3表示邮箱格式错误，-4表示密码错误
data.msg业务失败原因
data.uid用户私钥

手机注册 ​

手机号注册接口，注册成功返回用户私钥（uid）。

接口信息 ​

  • 方法: POST
  • URL: https://apis.bemfa.com/vb/api/v2/userRegister
  • Content-Type: application/json; charset=utf-8

请求参数 ​

参数类型是否必须说明
phonestring是手机号
passwordstring是密码，长度6-32位
areastring否手机区号，默认86
secretIDstring是企业 API 密钥 ID，认证后获取 立即认证
secretKeystring是企业 API 密钥，认证后获取 立即认证

提示

使用企业 API 密钥后，普通用户会自动绑定到该企业。

请求示例 ​

json
{
    "phone": "133xxxxxxxx",
    "password": "xxxxxx",
    "area": "86",
    "secretID": "yourSecretID",
    "secretKey": "yourSecretKey"
}

响应示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "code": 0,
        "msg": "",
        "uid": "04740180bf0944159fc857aafb004314"
    }
}

响应说明 ​

参数说明
code0表示请求处理成功
data.code0表示注册成功，-2表示手机号已注册，-3表示手机号错误
data.msg业务失败原因
data.uid用户私钥

手机登录 ​

手机号登录接口，登录成功返回用户私钥（uid）。

接口信息 ​

  • 方法: POST
  • URL: https://apis.bemfa.com/vb/api/v2/userLogin
  • Content-Type: application/json; charset=utf-8

请求参数 ​

参数类型是否必须说明
phonestring是手机号
passwordstring是密码，长度6-32位
areastring否手机区号，默认86
secretIDstring是企业 API 密钥 ID，认证后获取 立即认证
secretKeystring是企业 API 密钥，认证后获取 立即认证

提示

使用企业 API 密钥后，普通用户会自动绑定到该企业。

请求示例 ​

json
{
    "phone": "133xxxxxxxx",
    "password": "xxxxxx",
    "area": "86",
    "secretID": "yourSecretID",
    "secretKey": "yourSecretKey"
}

响应示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "code": 0,
        "msg": "",
        "uid": "7801e4ba1bf7406593d47250797860fd"
    }
}

响应说明 ​

参数说明
code0表示请求处理成功
data.code0表示登录成功，-3表示手机号错误或用户不存在，-4表示密码错误
data.msg业务失败原因
data.uid用户私钥

修改密码 ​

用户修改密码接口，修改成功后可使用新密码登录。要求手机号或邮箱至少传入一个，用于确认要修改密码的用户。

注意

如果已绑定该认证账号，可不传uid ，如果携带此参数，会自动完成绑定；用户未绑定认证账号，或已绑定到当前 secretID 和 secretKey 对应的认证账号时才允许修改密码。若用户已绑定到其他认证账号，会直接返回错误。若同时传入 phone 和 email，手机号和邮箱都必须与查询到的用户匹配。

接口信息 ​

  • 方法: POST
  • URL: https://apis.bemfa.com/vb/api/v2/changePassword
  • Content-Type: application/json; charset=utf-8

请求参数 ​

参数类型是否必须说明
uidstring否用户私钥，不传时按手机号或邮箱倒序查询最新用户
phonestring否手机号，phone 和 email 至少传入一个
emailstring否邮箱，phone 和 email 至少传入一个
areastring否手机区号，默认86
newPasswordstring是新密码，长度6-32位
secretIDstring是企业 API 密钥 ID，认证后获取 立即认证
secretKeystring是企业 API 密钥，认证后获取 立即认证

提示

使用企业 API 密钥后，普通用户会自动绑定到该企业。

携带 uid 的手机号请求示例 ​

json
{
    "uid": "7d54f85af42976ee3c2693e692a6bb59",
    "phone": "133xxxxxxxx",
    "area": "86",
    "newPassword": "xxxxxx1",
    "secretID": "yourSecretID",
    "secretKey": "yourSecretKey"
}

不携带 uid 的手机号请求示例 ​

json
{
    "phone": "133xxxxxxxx",
    "area": "86",
    "newPassword": "xxxxxx1",
    "secretID": "yourSecretID",
    "secretKey": "yourSecretKey"
}

邮箱请求示例 ​

json
{
    "email": "133xxxxxxx@qq.com",
    "newPassword": "xxxxxx1",
    "secretID": "yourSecretID",
    "secretKey": "yourSecretKey"
}

响应示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "code": 0,
        "msg": ""
    }
}

错误响应 ​

请求参数错误、用户不存在、手机号或邮箱为空、手机号或邮箱不匹配、用户已绑定其他认证账号、secretID 或 secretKey 错误时，接口直接返回错误信息。

json
{
    "code": -1,
    "msg": "secretID或secretKey错误",
    "data": ""
}

绑定用户 ​

绑定用户接口，用于把已有用户绑定到当前 secretID 和 secretKey 对应的认证账号。要求传入 uid，并且手机号或邮箱至少传入一个，用于确认要绑定的用户。 登录、注册等会自动完成绑定，不用重复绑定。

注意

用户未绑定认证账号，或已绑定到当前 secretID 和 secretKey 对应的认证账号时才允许绑定。若用户已绑定到其他认证账号，会直接返回错误。若同时传入 phone 和 email，手机号和邮箱都必须与 uid 对应的用户匹配。

接口信息 ​

  • 方法: POST
  • URL: https://apis.bemfa.com/vb/api/v2/bindUser
  • Content-Type: application/json; charset=utf-8

请求参数 ​

参数类型是否必须说明
uidstring是用户私钥
phonestring否手机号，phone 和 email 至少传入一个
emailstring否邮箱，phone 和 email 至少传入一个
areastring否手机区号，默认86
secretIDstring是企业 API 密钥 ID，认证后获取 立即认证
secretKeystring是企业 API 密钥，认证后获取 立即认证

提示

使用企业 API 密钥后，普通用户会自动绑定到该企业。

手机号请求示例 ​

json
{
    "uid": "7d54f85af42976ee3c2693e692a6bb59",
    "phone": "133xxxxxxxx",
    "area": "86",
    "secretID": "yourSecretID",
    "secretKey": "yourSecretKey"
}

邮箱请求示例 ​

json
{
    "uid": "7d54f85af42976ee3c2693e692a6bb59",
    "email": "133xxxxxxx@qq.com",
    "secretID": "yourSecretID",
    "secretKey": "yourSecretKey"
}

响应示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "code": 0,
        "msg": "",
        "uid": "7d54f85af42976ee3c2693e692a6bb59"
    }
}

错误响应 ​

请求参数错误、用户不存在、手机号或邮箱为空、手机号或邮箱不匹配、用户已绑定其他认证账号、secretID 或 secretKey 错误时，接口直接返回错误信息。

json
{
    "code": -1,
    "msg": "用户已绑定其他认证账号",
    "data": ""
}

获取公众号绑定二维码 ​

获取公众号绑定二维码接口。接口会先校验 secretID 和 secretKey，再通过 openID 查询用户并完成用户绑定；用户扫码后可将该用户绑定到微信公众号。

注意

绑定二维码有效期为 1 天，只能扫码一次，扫码后立即失效。同一用户已绑定公众号时不能重复获取绑定二维码；若已注册或已绑定公众号的微信用户扫描该二维码，不会绑定到二维码创建者账号，会继续走公众号原有注册/登录流程。

接口信息 ​

  • 方法: POST
  • URL: https://pro.bemfa.com/v4/official/v1/wechatBindQrcode
  • Content-Type: application/json; charset=utf-8

请求参数 ​

参数类型是否必须说明
openIDstring是用户私钥
secretIDstring是企业 API 密钥 ID，认证后获取 立即认证
secretKeystring是企业 API 密钥，认证后获取 立即认证

提示

使用企业 API 密钥后，普通用户会自动绑定到该企业。

请求示例 ​

json
{
    "openID": "7d54f85af42976ee3c2693e692a6bb59",
    "secretID": "yourSecretID",
    "secretKey": "yourSecretKey"
}

响应示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "url": "https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=gQGA7zwAAAAAAAAAAS5odHRwOi8vd2VpeGluLnFxLmNvbS9xLzAySW12MWhnUUNmcGwxdXpMa2hHY24AAgSjYi1qAwQAjScA"
    }
}

响应说明 ​

参数说明
data.url微信二维码链接，可直接用于展示二维码图片

错误响应 ​

请求参数错误、用户不存在、用户已绑定公众号、secretID 或 secretKey 错误、二维码获取失败时，接口直接返回错误信息。

json
{
    "code": -1,
    "msg": "secretID或secretKey错误",
    "data": ""
}

账号注销 ​

账号注销暂不提供开放 API。如需注销账号，请用户使用巴法 App 进入账号相关页面自行提交注销申请。

设置新的AppID和SecretKey ​

仅用于MQTT连接使用

生成新的AppID和SecretKey。调用成功后，系统会生成新的AppID和SecretKey，旧的密钥不会失效。

接口信息 ​

  • 方法: POST
  • URL: https://pro.bemfa.com/vs/web/v1/userSecretKey
  • Content-Type: application/json; charset=utf-8

请求参数 ​

参数类型是否必须说明
openIDstring是用户私钥

请求示例 ​

json
{
    "openID": "7801e4ba1bf7406593d47250797860fd"
}

响应示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "appID": "beid_xQjMwcjN0EzNx8VM3UDN3A",
        "secretKey": "7IoRBu2g4kSMywplr9ihofJz4n90HsW9"
    }
}

响应说明 ​

参数类型说明
appIDstring应用ID
secretKeystring应用密钥

获取所有AppID ​

获取用户所有的AppID列表。

接口信息 ​

  • 方法: GET
  • URL: https://pro.bemfa.com/vs/web/v1/userAppID

请求参数 ​

参数类型是否必须说明
openIDstring是用户私钥

响应示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "appIDs": [
            "beid_xQjMwcjN0EzNx8VM3UDN3A",
            "beid_2IzNwcjN0EzNx8VM3UDN3A",
            "beid_3IzNwcjN0EzNx8VM3UDN3A"
        ]
    }
}

响应说明 ​

参数类型说明
appIDsstring[]AppID列表

删除AppID ​

删除指定的AppID。

接口信息 ​

  • 方法: POST
  • URL: https://pro.bemfa.com/vs/web/v1/userDeleteKey
  • Content-Type: application/json; charset=utf-8

请求参数 ​

参数类型是否必须说明
openIDstring是用户私钥
appIDstring是要删除的AppID

请求示例 ​

json
{
    "openID": "7801e4ba1bf7406593d47250797860fd",
    "appID": "beid_xcTN0cD"
}

响应示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "code": 0
    }
}

响应说明 ​

参数类型说明
codenumber0表示删除成功

巴法开放联盟

BeHome Alliance