用户信息

用户手机注册

通过对URL的访问实现用户的注册,并且返回用户注册后在青莲云的唯一标识userId和userToken,请妥善保管,后续接口需要使用这一对标识来进行身份验证。如果丢失可以通过32接口来获取数据。

请求URL:

curl "https://HOST/open/v1/user/register"

-d "uid=x&sign=xxxxxx&tt=xx&phone=xxx&password=xxx"

返回的 JSON 数据:

{

"code": 0,

"msg":"xxxxxxxxxxx",

"data": "{\"userId\":\"xxxxxx\",\"userToken\":\"xxxxxx\"}"

}

请求参数:

参数名 类型 说明 备注 必需
uid Int 用户id 参考相关参数章节 是
tt Int 时间戳 参考相关参数章节 是
sign String 用户签名 参考相关参数章节 是
phone String 用户手机号 是
password String 用户密码 是

返回参数:

参数名 类型 说明 备注 必需
data String 返回userId和userToken Json格式的字符串 是
code Int 返回码 查看Api返回码 是
msg String 返回信息 如果code为0,则msg为空;
如果code不为0,则msg返回
的为相关错误信息
是
userId String 用户在平台唯一id 妥善保管 是
userToken String 用户的token 妥善保管 是

用户和设备绑定

通过对URL的访问实现用户的唯一标识userId和设备的唯一标识绑定。用户绑定设备只针对主设备,不进行子设备绑定。

请求URL:

curl "https://HOST/open/v2/device/bind"

-d "uid=x&sign=xxxxxx&tt=xx&userId=xxx&userToken=xxx&mac=5c:cf:7f:c1:0b:fd"

返回的 JSON 数据:

{

"code": 0,

"msg":"xxxxxxxxxxx"

}

请求参数:

参数名 类型 说明 备注 必需
uid Int 用户id 参考相关参数章节 是
tt Int 时间戳 参考相关参数章节 是
sign String 用户签名 参考相关参数章节 是
userId String 用户唯一标识id 通过接口13获取 是
userToken String 用户唯一标识token 通过接口13获取 是
mac String 设备的Mac 如: 5c:cf:7f:c1:0b:fd 是

返回参数:

参数名 类型 说明 备注 必需
code Int 返回码 查看Api返回码 是
msg String 返回信息 如果code为0,则msg为空;如果code不为0,
则msg返回的为相关错误信息
是

用户和设备解绑

通过对URL的访问实现用户的唯一标识userId和设备的唯一标识解除绑定。用户解绑设备只针对主设备,不进行子设备解绑。

请求URL:

curl "https://HOST/open/v2/device/unbind"

-d "uid=x&sign=xxxxxx&tt=xx&userId=xxx&userToken=xxx&mac=5c:cf:7f:c1:0b:fd"

返回的 JSON 数据:

{

"code": 0,

"msg":"xxxxxxxxxxx"

}

请求参数:

参数名 类型 说明 备注 必需
uid Int 用户id 参考相关参数章节 是
tt Int 时间戳 参考相关参数章节 是
sign String 用户签名 参考相关参数章节 是
userId String 用户唯一标识id 通过接口13获取 是
userToken String 用户唯一标识token 通过接口13获取 是
mac String 设备的Mac 如: 5c:cf:7f:c1:0b:fd 是

返回参数:

参数名 类型 说明 备注 必需
code Int 返回码 查看Api返回码 是
msg String 返回信息 如果code为0,则msg为空;
如果code不为0,则msg返回的为相关错误信息
是

分享者分享设备

通过对URL的访问实现用户对自己的设备分享给其他用户,而且该用户必须是在青莲云注册过的用户。分享之后,被分享者可以通过获取消息中心获取被分享的消息,来进行接受分享或者拒绝分享。分享相关只针对主设备,子设备分享关系跟随主设备。

请求URL:

curl "https://HOST/open/v1/share/device/add"

-d "uid=x&sign=xxxxxx&tt=xx&userId=xxx&userToken=xxx&iotId=xxx&tel=xxx"

返回的 JSON 数据:

{

"code": 0,

"msg":"xxxxxxxxxxx"

}

请求参数:

参数名 类型 说明 备注 必需
uid Int 用户id 参考相关参数章节 是
tt Int 时间戳 参考相关参数章节 是
sign String 用户签名 参考相关参数章节 是
userId String 用户唯一标识id 通过接口13获取 是
userToken String 用户唯一标识token 通过接口13获取 是
iotId String 设备唯一标识id 通过设备sdk连接青莲云获取 是
tel String 被分享者的手机号 是

返回参数:

参数名 类型 说明 备注 必需
code Int 返回码 查看Api返回码 是
msg String 返回信息 如果code为0,则msg为空;
如果code不为0,则msg返回的为相关错误信息
是

分享者取消分享设备

通过对URL的访问实现用户对自己的分享的设备取消分享给指定用户,则该用户将不会再看到被取消的设备。分享相关只针对主设备,子设备分享关系跟随主设备。

请求URL:

curl "https://HOST/open/v1/share/device/cancel"

-d "uid=x&sign=xxxxxx&tt=xx&userId=xxx&userToken=xxx&iotId=xxx&tUserId=xxx&tStatus=xxx "

返回的 JSON 数据:

{

"code": 0,

"msg":"xxxxxxxxxxx"

}

请求参数:

参数名 类型 说明 备注 必需
uid Int 用户id 参考相关参数章节 是
tt Int 时间戳 参考相关参数章节 是
sign String 用户签名 参考相关参数章节 是
userId String 用户唯一标识id 通过接口13获取 是
userToken String 用户唯一标识token 通过接口13获取 是
iotId String 设备唯一标识id 通过设备sdk连接青莲云获取 是
tUserId String 被分享者的唯一标识id 消息中心会返回所有信息(接口20获取) 是
tStatus Int 被分享者此时的状态 所有的状态都是用户获取消息中心获取
(接口20获取),因此取消、拒绝、接
受等状态需要提前获取。 被分享者状态
(0、删除消息,1、未操作,2、接收共享,
3、拒绝共享, 4、删除共享)
是

返回参数:

参数名 类型 说明 备注 必需
code Int 返回码 查看Api返回码 是
msg String 返回信息 如果code为0,则msg为空;
如果code不为0,则msg返回的为相关错误信息
是

被分享者接受分享设备

通过对URL的访问实现用户接受他人分享的设备,设备列表将可以查询到该分享的设备。分享相关只针对主设备,子设备分享关系跟随主设备。

请求URL:

curl "https://HOST/open/v1/share/device/accept"

-d "uid=x&sign=xxxxxx&tt=xx&userId=xxx&userToken=xxx&iotId=xxx&fUserId=xxx"

返回的 JSON 数据:

{

"code": 0,

"msg":"xxxxxxxxxxx"

}

请求参数:

参数名 类型 说明 备注 必需
uid Int 用户id 参考相关参数章节 是
tt Int 时间戳 参考相关参数章节 是
sign String 用户签名 参考相关参数章节 是
userId String 用户唯一标识id 通过接口13获取 是
userToken String 用户唯一标识token 通过接口13获取 是
iotId String 设备唯一标识id 通过设备sdk连接青莲云获取 是
fUserId String 分享者的唯一标识id 消息中心会返回所有信息(接口22获取) 是

返回参数:

参数名 类型 说明 备注 必需
code Int 返回码 查看Api返回码 是
msg String 返回信息 如果code为0,则msg为空;
如果code不为0,则msg返回的为相关错误信息
是

被分享者删除被分享的设备

通过对URL的访问实现用户接受他人分享的设备,设备列表将可以查询到该分享的设备。分享相关只针对主设备,子设备分享关系跟随主设备。

请求URL:

curl "https://HOST/open/v1/share/device/delete"

-d "uid=x&sign=xxxxxx&tt=xx&userId=xxx&userToken=xxx&iotId=xxx&fUserId=xxx"

返回的 JSON 数据:

{

"code": 0,

"msg":"xxxxxxxxxxx"

}

请求参数:

参数名 类型 说明 备注 必需
uid Int 用户id 参考相关参数章节 是
tt Int 时间戳 参考相关参数章节 是
sign String 用户签名 参考相关参数章节 是
userId String 用户唯一标识id 通过接口13获取 是
userToken String 用户唯一标识token 通过接口13获取 是
iotId String 设备唯一标识id 通过设备sdk连接青莲云获取,被分享的设备id 是
fUserId String 分享者的唯一标识id 消息中心会返回所有信息(接口21获取) 是

返回参数:

参数名 类型 说明 备注 必需
code Int 返回码 查看Api返回码 是
msg String 返回信息 如果code为0,则msg为空;
如果code不为0,则msg返回的为相关错误信息
是

获取分享中心消息

通过对URL的访问实现用户获取所有的分享中心消息。分享相关只针对主设备,子设备分享关系跟随主设备。

请求URL:

curl "https://HOST/open/v1/share/message"

-d "uid=x&sign=xxxxxx&tt=xx&userId=xxx&userToken=xxx"

返回的 JSON 数据:

{

"code": 0,

"msg":"xxxxxxxxxxx",

"data": "{\"message\":[

{\"deviceName\":\"xxx\",\"fName\":\"xxx\",\"fTel\":\"xxx\",\"fid\":x,\"fstatus\":x,\"iotid\":\"xxx\",\"productId\":xxx,\"tName\":\"xxx\",\"tTel\":\"xxx\",\"tid\":x,\"time\":xxx,\"tstatus\":x},

{\"deviceName\":\"xxx\",\"fName\":\"xxx\",\"fTel\":\"xxx\",\"fid\":x,\"fstatus\":x,\"iotid\":\"xxx\",\"productId\":xxx,\"tName\":\"xxx\",\"tTel\":\"xxx\",\"tid\":x,\"time\":xxx,\"tstatus\":x}

]}"

}

请求参数:

参数名 类型 说明 备注 必需
uid Int 用户id 参考相关参数章节 是
tt Int 时间戳 参考相关参数章节 是
sign String 用户签名 参考相关参数章节 是
userId String 用户唯一标识id 通过接口13获取 是
userToken String 用户唯一标识token 通过接口13获取 是
iotId String 设备唯一标识id 通过设备sdk连接青莲云获取,被分享的设备id 是
fUserId String 分享者的唯一标识id 消息中心会返回所有信息(接口21获取) 是

返回参数:

参数名 类型 说明 备注 必需
code Int 返回码 查看Api返回码 是
msg String 返回信息 如果code为0,则msg为空;
如果code不为0,则msg返回
的为相关错误信息
是
data String 返回message的
ArrayJson字符串
数据格式如下,
Json格式的字符串
是
deviceName String 被分享的设备名称 是
fName String 分享者的名字 是
fTel String 分享者的手机号 是
fid Int 分享者的唯一标识id 是
fstatus Int 分享者的状态 分享者状态:
0、删除消息
1、发出共享
2、取消共享
是
iotid String 设备的唯一标识id 是
productId Int 产品唯一标识id 是
tName String 被分享者名字 是
tTel String 被分享者电话 是
tid Int 被分享者唯一标识id 是
tstatus Int 被分享者状态 被分享者状态:
0、删除消息
1、未操作
2、接收共享
3、拒绝共享
4、删除共享
是
time Long 分享时间 时间戳 是

第三方用户体系用户注册

通过对URL的访问实现第三方用户体系用户的注册,并且返回在平台移动用户的唯一标识userId和userToken,请妥善保管,后续接口需要使用这一对标识来进行身份验证。该接口是模拟移动端SDK注册用户,因此改接口注册的用户会产生一些功能的不能使用,如下:1、用户登录;2、修改、重置密码;3、修改手机号、邮箱、用户名;4、获取个人信息;5、设备分享模块(涉及到分享的时候输入用户手机号或邮箱)6、修改密码另一个登录同账号的用户被挤掉;7、设备端获取绑定者和分享者的个人信息;这些功能都需要直接通过手机号注册或者邮箱注册的。

请求URL:

curl "https://HOST/open/v1/third/user/register"

-d "uid=x&sign=xxxxxx&tt=xx&appid=xxx&thirdUserId=xxx&password=xxx"

返回的 JSON 数据:

{

"code": 0,

"msg":"xxxxxxxxxxx",

​ "data": "{\"userId\":\"xxxxxx\",\"userToken\":\"xxxxxx\"}"

}

请求参数:

参数名 类型 说明 备注 必需
uid Int 用户id 参考相关参数章节 是
tt Int 时间戳 参考相关参数章节 是
sign String 用户签名 参考相关参数章节 是
appid String 青莲云的应用id 该接口模拟手机注册,就需要
应用id和SDK的应用id一致
是
thirdUserId String 第三方用户体系的用户id 需要保证该公司uid下唯一 是
password String 用户密码 第三方平台设置用户默认密码 是

返回参数:

参数名 类型 说明 备注 必需
data String 返回userId和userToken Json格式的字符串 是
code Int 返回码 查看Api返回码 是
msg String 返回信息 如果code为0,则msg为空;如果code
不为0,则msg返回的为相关错误信息
是
userId String 用户在平台唯一id 妥善保管 是
userToken String 用户的token 妥善保管 是

第三方用户体系获取平台用户信息

通过对URL的访问实现通过第三方用户体系用户id获取通过30接口注册的平台用户,返回平台移动用户的唯一标识userId和userToken,请妥善保管,后续接口需要使用这一对标识来进行身份验证。

请求URL:

curl "https://HOST/open/v1/third/user/get"

-d "uid=x&sign=xxxxxx&tt=xx&appid=xxx&thirdUserId=xxx"

返回的 JSON 数据:

{

"code": 0,

"msg":"xxxxxxxxxxx",

​ "data": "{\"userId\":\"xxxxxx\",\"userToken\":\"xxxxxx\"}"

}

请求参数:

参数名 类型 说明 备注 必需
uid Int 用户id 参考相关参数章节 是
tt Int 时间戳 参考相关参数章节 是
sign String 用户签名 参考相关参数章节 是
appid String 青莲云的应用id 和SDK的应用id一致 是
thirdUserId String 第三方用户体系的用户id 需要保证该公司uid下唯一 是

返回参数:

参数名 类型 说明 备注 必需
data String 返回userId和userToken Json格式的字符串 是
code Int 返回码 查看Api返回码 是
msg String 返回信息 如果code为0,则msg为空;
如果code不为0,则msg返回的为相关错误信息
是
userId String 用户在平台唯一id 妥善保管 是
userToken String 用户的token 妥善保管 是

通过用户手机号获取userId和userToken

通过对URL的访问实现通过用户的手机号和密码查询获取用户的唯一ID和token,请妥善保管,后续接口需要使用这一对标识来进行身份验证。

请求URL:

curl "https://HOST/open/v1/user/get"

-d "uid=x&sign=xxxxxx&tt=xx& phone=xxx&password=xxx"

返回的 JSON 数据:

{

"code": 0,

"msg":"xxxxxxxxxxx",

​ "data": "{\"userId\":\"xxxxxx\",\"userToken\":\"xxxxxx\"}"

}

请求参数:

参数名 类型 说明 备注 必需
uid Int 用户id 参考相关参数章节 是
tt Int 时间戳 参考相关参数章节 是
sign String 用户签名 参考相关参数章节 是
phone String 用户手机号 是
password String 用户密码 是

返回参数:

参数名 类型 说明 备注 必需
data String 返回userId和userToken Json格式的字符串 是
code Int 返回码 查看Api返回码 是
msg String 返回信息 如果code为0,则msg为空;
如果code不为0,则msg返回的为相关错误信息
是
userId String 用户在平台唯一id 妥善保管 是
userToken String 用户的token 妥善保管 是
Copyright & copy qinglianyun all right reserved,powered by Gitbook该文件修订时间: 2021-04-22 18:53:48

results matching ""

    No results matching ""