用户注册

一、应用场景

用户注册是提供给C端用户自主注册账号的功能。用户在首次需要登入App时，可以注册个人账号用于登录。物联云平台目前提供邮箱注册和手机号注册两种方式。用户通过邮箱或手机号注册都需要先在物联云平台管理台配置对应的消息模板。通过邮件注册，需要用户打开邮件后点击激活链接进行认证。通过手机号注册，需要用户填入接收到的验证码进行认证。

  • 用户通过手机号注册App的登录账号。

  • 用户通过邮箱注册App的登录账号。

二、功能说明

企业提供给用户通过邮箱注册功能时，需要前往物联云平台管理台【应用中心->集成->邮件服务】中选择企业使用的邮箱渠道。完成后需要配置【邮件模板->系统推荐->激活账号】对应的模板信息。未配置邮件模板的情况下，平台会使用默认的激活账号模板发送邮件。

用户使用邮箱进行注册账号时，会在邮箱中接收到物联云平台发送的激活邮件。用户需要在激活邮件中点击激活链接进行激活后，才可以正式使用账号。

企业提供给用户通过手机号注册功能时，需要前往物联云平台管理台【应用中心->集成->短信服务】中设置企业使用的短信运营商。设置过程中需要将激活短信的签名和模板id填写至运营商信息中。并将填写好的运营商设置为默认运营商。平台会使用运营商中的激活账号模板发送手机短信。

用户使用手机号进行注册账号时，会接收到物联云平台发送的激活短信。用户需要在激活短信中的验证码填写并提交后，才可以正式使用账号。

三、前提条件

1.完成邮件服务和邮件模板的配置，并保证邮件服务的可用性。
2.完成短信服务和短信模板的配置，并保证短信服务的可用性。
3.用户注册时提供的邮箱或手机可以接收到信息。

四、关键流程

4.1 用户手机验证码注册

流程说明：

  • 首先，**C端APP用户 **在APP上输入要注册的手机号后向物联网中台发起 获取手机验证码 请求以获得手机验证码，将收到的手机验证码填入APP进行注册；由于企业设置了一个手机号码一天内获取验证码的阈值，当超过该阈值时需要通过图片验证码才能获取手机验证码，因此被限流之后APP需要向物联网中台发起 获取图片验证码 请求得到图片验证码地址用于展示图片验证码。
  • 其次，C端APP用户 根据手机验证码向物联网中台发起 用户注册 请求。
  • 最后，物联网中台接收到用户注册请求后进行手机号码与验证码校验，业务逻辑校验通过后将手机号码注册为物联网中台的一个C端APP用户账号。

用户手机验证码注册

4.2 用户邮箱验证码注册

流程说明：

  • 首先，**C端APP用户 **在APP上输入要注册的邮箱后向物联网中台发起 获取邮箱验证码 请求以获得邮箱验证码。
  • 其次，C端APP用户 根据邮箱验证码向物联网中台发起 用户邮箱注册 请求。
  • 最后，物联网中台接收到用户邮箱注册 请求后进行邮箱与验证码校验，业务逻辑校验通过后将邮箱号码注册为物联网中台的一个C端APP用户账号。

用户邮箱验证码注册

4.3 用户邮箱激活注册

流程说明：

  • 首先，**C端APP用户 **在APP上输入要注册的邮箱后向物联网中台发起 用户注册 请求。
  • 其次，物联网中台接收到 用户注册 请求后进行邮箱校验，为邮箱创建一个物联网中台C端APP用户账号，但此时邮箱账号未被验证处于待激活状态；与此同时，物联网中台向注册邮箱发送一封账号激活邮件附带激活链接。
  • 再次，**C端APP用户 **接收到激活链接邮件后，点击激活链接向物联网中台发起 用户注册激活 请求。
  • 最后，物联网中台接收到 用户注册激活 请求后校验激活参数合法性后，将C端APP邮箱账号变为已激活状态，至此用户邮箱注册账号方可使用。

用户邮箱激活注册

五、API列表

5.1 用户注册

5.1.1 用户注册-获取手机验证码

接口描述

互联网用户使用App使用手机号码注册为注册成为物联云平台用户前，请求发送一封手机验证码的短信，手机验证码有效期是120秒。

请求方式

POST

请求地址

/v2/user_register/verifycode

请求头

名称 必填 类型 备注
Content-Type true String application/json

请求参数

名称 位置 必填 类型 备注
corp_id body true String 企业标识
phone body true String 手机号
phone_zone body false String 手机区号
captcha body false String 图片验证码，当调用本接口到了一定次数以后需要该字段
plugin_id body false String 注册用户绑定的应用标识

请求示例：

{
    "corp_id":"1235sdfsd5465df5ds",
    "phone":"13838383388",
    "phone_zone":"+86",
    "captcha":"265621",
    "plugin_id":"265655233sdfs6"
}

返回参数说明

名称 必填 类型 备注
无 无 无 无

返回示例：

{
}

错误码：

错误码 描述
4001001 请求数据字段验证不通过
4001002 请求数据必须字段不可为空
4041001 接口不存在
5031001 系统错误
4041010 企业不存在
4001052 短信额度到达上限

5.1.2 用户注册-获取图片验证码

接口描述

当互联网用户的注册手机在一定时间段内获取手机验证码过于频繁时，此时获取手机验证码被要求需要图片验证码防止机刷手机验证码

请求方式

POST

请求地址

/v2/user_register/captcha

请求头

名称 必填 类型 备注
Content-Type true String application/json

请求参数

名称 位置 必填 类型 备注
corp_id body true String 企业标识
phone body true String 手机号
phone_zone body false String 手机区号

请求示例：

{
    "corp_id":"1235sdfsd5465df5ds",
    "phone":"13838383388",
    "phone_zone":"+86"
}

返回参数说明

名称 必填 类型 备注
url true String 验证码图片地址

返回示例：

{
    "url": "http://www.baidu.com"
}

错误码：

错误码 描述
4001001 请求数据字段验证不通过
4001002 请求数据必须字段不可为空
4041001 接口不存在
5031001 系统错误
4041010 企业不存在

5.1.3 用户注册

接口描述

互联网用户通过手机号或者邮箱地址注册成为物联云平台用户，该接口适用于手机注册和邮箱注册，当参数同时存在手机和邮箱时优先识别手机号从而忽略邮箱地址；该接口使用手机号注册时需要传手机验证码，从而直接将用户标识为已认证；该接口使用邮箱注册时会向互联网用户发送用户激活邮件，只有收到激活邮件并进行激活后用户账号才正式可用

请求方式

POST

请求地址

/v2/user_register

请求头

名称 必填 类型 备注
Content-Type true String application/json

请求参数

名称 位置 必填 类型 备注
corp_id body true String 企业标识
phone body false String 手机号, 通过手机号注册
phone_zone body false String 手机区号, 通过手机号注册
verifycode body false String 手机短信验证码, 通过手机号注册
email body false String 邮箱地址, 通过邮箱注册
nickname body true String 用户昵称
password body true String 用户密码
source body false Int 用户来源 用户来源，枚举：
1：web
2：android
3：ios
4：wechat
5：qq
6：weibo
7：facebook
8：twitter
9：sms
10：other
local_lang body false String 本地语言代码
zh-cn:中国
en-us:美国
de:德国
se:瑞典
fr:法国
nl:荷兰
it:意大利
fi:芬兰
no:挪威
dk:丹麦
pl:波兰
es:西班牙
pt:葡萄牙
cz:捷克
sk:斯洛伐克
si:斯洛文尼亚
hr:克罗地亚
hu:匈牙利
ro:罗马尼亚
bg:保加利亚
ru:俄罗斯
plugin_id body false String 用户归属的应用标识

请求示例：

{
    "corp_id": "123654dsfae12ee",
    "phone": "13838383388",
    "phone_zone": "+86",
    "verifycode": "852639",
    "email": "liqinghua@xlink.cn",
    "nickname": "李清华",
    "password": "Test@#$%^&",
    "source": 1,
    "local_lang": "zh-cn",
    "plugin_id": "5615641562345555"
}

返回参数说明

名称 必填 类型 备注
user_id true Int 成员总数
phone false String 手机号, 通过手机号注册
phone_zone false String 手机区号, 通过手机号注册
email false String 邮箱地址, 通过邮箱注册
status true Int 邮箱是否已注册状态
1:注册成功
2: 已注册

返回示例：

{
    "user_id": 12456123515,
    "phone": "138383388",
    "phone_zone": "+86",
    "email": "liqinghua@xlink.cn",
    "status": 1
}

错误码：

错误码 描述
4001001 请求数据字段验证不通过
4001002 请求数据必须字段不可为空
4041001 接口不存在
5031001 系统错误
4001005 手机已注册
4001006 注册的邮箱已存在
4041020 应用不存在

5.1.4 用户注册激活

接口描述

互联网用户使用App使用5.1.3 用户注册邮箱注册时，物联网中台向邮箱发送激活链接，用户点击激活链接进行邮箱账号激活。

请求方式

POST

请求地址

/v2/user_email_activate

请求头

名称 必填 类型 备注
Content-Type true String application/json

请求参数

名称 位置 必填 类型 备注
corp_id body true String 企业标识
verifycode body true String 邮箱验证码
email body true String 邮箱地址

请求示例：

{
    "corp_id": "15423sdfwe14f5weefd",
    "verifycode": "邮箱验证码",
    "email": "liqinghua@xlink.cn"
}

返回参数说明

名称 必填 类型 备注
无 无 无 无

返回示例：

{
}

错误码：

错误码 描述
4001001 请求数据字段验证不通过
4001002 请求数据必须字段不可为空
4041001 接口不存在
5031001 系统错误
4041010 企业不存在

5.2 用户邮箱验证码注册

5.2.1 用户邮箱注册-获取邮箱验证码

接口描述

互联网用户使用App使用邮箱注册为注册成为物联云平台用户前，请求发送一封邮箱验证码的短信，邮箱验证码有效期是120秒。

请求方式

POST

请求地址

/v2/user_register/email/verifycode

请求头

名称 必填 类型 备注
Content-Type true String application/json

请求参数

名称 位置 必填 类型 备注
corp_id body true String 企业标识
email body true String 邮箱地址
local_lang body false String 本地语言代码
zh-cn:中国
en-us:美国
de:德国
se:瑞典
fr:法国
nl:荷兰
it:意大利
fi:芬兰
no:挪威
dk:丹麦
pl:波兰
es:西班牙
pt:葡萄牙
cz:捷克
sk:斯洛伐克
si:斯洛文尼亚
hr:克罗地亚
hu:匈牙利
ro:罗马尼亚
bg:保加利亚
ru:俄罗斯

请求示例：

{
    "corp_id": "15423sdfwe14f5weefd",
    "email": "liqinghua@xlink.cn",
    "local_lang": "zh-cn"
}

返回参数说明

名称 必填 类型 备注
无 无 无 无

返回示例：

{
}

错误码：

错误码 描述
4001001 请求数据字段验证不通过
4001002 请求数据必须字段不可为空
4041001 接口不存在
5031001 系统错误
4041010 企业不存在

5.2.2 用户邮箱注册

接口描述

互联网用户使用App使用邮箱配合邮箱验证码注册为注册成为物联云平台用户。

请求方式

POST

请求地址

/v2/user_register/email

请求头

名称 必填 类型 备注
Content-Type true String application/json

请求参数

名称 位置 必填 类型 备注
corp_id body true String 企业标识
verifycode body true String 邮箱验证码
email body true String 邮箱地址
nickname body true String 用户昵称，长度2-32个字符
password body true String 用户密码
source body true Int 用户来源 用户来源，枚举：
1：web
2：android
3：ios
4：wechat
5：qq
6：weibo
7：facebook
8：twitter
9：sms
10：other
local_lang body false String 本地语言代码
zh-cn:中国
en-us:美国
de:德国
se:瑞典
fr:法国
nl:荷兰
it:意大利
fi:芬兰
no:挪威
dk:丹麦
pl:波兰
es:西班牙
pt:葡萄牙
cz:捷克
sk:斯洛伐克
si:斯洛文尼亚
hr:克罗地亚
hu:匈牙利
ro:罗马尼亚
bg:保加利亚
ru:俄罗斯

请求示例：

{
    "corp_id": "15423sdfwe14f5weefd",
    "verifycode": "邮箱验证码",
    "email": "liqinghua@xlink.cn",
    "nickname": "李清华",
    "password": "Test@#$%^&",
    "source": 1,
    "local_lang": "zh-cn"
}

返回参数说明

名称 必填 类型 备注
无 无 无 无

返回示例：

{
}

错误码：

错误码 描述
4001001 请求数据字段验证不通过
4001002 请求数据必须字段不可为空
4041001 接口不存在
5031001 系统错误
4041010 企业不存在

没找到需要的文档？
你可以提交工单反馈 或 阅读常见问题
客服工单常见问题