[关闭]
@soszrg 2017-05-31T10:33:19.000000Z 字数 3797 阅读 397

产品验证相关接口


v3前端接口 v3文档

创建虚拟设备(token)

POST /v3/product/vDevice/

请求参数

参数名 类型 必须 说明
product string 产品ID

返回值

  1. {
  2. "meta":{
  3. "message":"虚拟设备创建成功",
  4. "code":0
  5. },
  6. "data":{
  7. "fog_deviceid": "1abxrw..."
  8. }
  9. }

字段说明

错误码

错误代码 错误说明
29010 参数错误:具体内容查看Response的message字段

获取虚拟设备列表(token)

GET /v3/product/vDevice/list/

请求参数

参数名 类型 必须 说明
product string 产品ID

返回值

  1. {
  2. "meta":{
  3. "message":"虚拟设备列表",
  4. "code":0
  5. },
  6. "data":{
  7. "count":3,
  8. "next":null,
  9. "previous":null,
  10. "results":[
  11. {
  12. "deviceid":"2c7f46a13eb911e7aac2dc536017523b",
  13. "identification":"",
  14. "enduserid":"",
  15. "dsn":"1495435051",
  16. "app":"",
  17. "isbinded":false
  18. },
  19. {
  20. "deviceid":"21d26d403eb911e7a2c9dc536017523b",
  21. "identification":"",
  22. "enduserid":"4d1939513ede11e7b3abdc536017523b",
  23. "app":"07f21838-20ed-11e7-a554-fa163e876164",
  24. "isbinded":true,
  25. "dsn":"1495435041"
  26. },
  27. {
  28. "deviceid":"1a8c8ca13eb911e7abe3dc536017523b",
  29. "identification":"",
  30. "enduserid":"",
  31. "app":"",
  32. "dsn":"1495435031",
  33. "isbinded":false
  34. }
  35. ]
  36. }
  37. }

字段说明

字段名 类型 必须
deviceid string 虚拟设备ID
identification string 当前绑定该虚拟设备的用户(邮箱或手机号)
isbinded bool 该虚拟设备是否被绑定
appid string 应用ID
enduserid string APP终端用户ID

错误码

错误代码 错误说明
29010 参数错误:具体内容查看Response的message字段

解绑虚拟设备(token)

DELETE /v3/product/virtual/bind/

请求参数

参数名 类型 必须 说明
deviceid string 虚拟设备ID
enduserid string 终端用户ID

说明

返回值

  1. {
  2. "meta":{
  3. "message":"解绑虚拟设备[qsxfgs...]成功",
  4. "code":0
  5. },
  6. "data":{
  7. }
  8. }

字段说明

字段名 类型 必须

错误码

错误代码 错误说明
29010 参数错误:具体内容查看Response的message字段

绑定虚拟用户(token)

POST /v3/product/virtual/bind/

请求参数

参数名 类型 必须 说明
product string 产品ID
app string APP ID
dsn string 设备串号或MAC地址

返回值

  1. {
  2. "meta":{
  3. "message":"虚拟用户绑定到设备[21d26d403eb911e7a2c9dc536017523b]",
  4. "code":0
  5. },
  6. "data":{
  7. }
  8. }

字段说明

字段名 类型 必须

错误码

错误代码 错误说明
29010 参数错误:具体内容查看Response的message字段

获取虚拟用户绑定设备的列表(token)

GET /v3/product/vEndUser/devices/

请求参数

参数名 类型 必须 说明
product string 产品ID
app string APP ID

返回值

  1. {
  2. "meta":{
  3. "message":"设备列表",
  4. "code":0
  5. },
  6. "data":{
  7. "count":2,
  8. "next":null,
  9. "previous":null,
  10. "results":[
  11. {
  12. "device":"21d26d403eb911e7a2c9dc536017523b",
  13. "enduser":"4d1939513ede11e7b3abdc536017523b"
  14. },
  15. {
  16. "device":"0f6c692e394111e7bb56dc536017523b",
  17. "enduser":"4d1939513ede11e7b3abdc536017523b"
  18. }
  19. ]
  20. }
  21. }

字段说明

字段名 类型 必须
device string 设备ID
enduser string 虚拟用户ID

错误码

错误代码 错误说明
29010 参数错误:具体内容查看Response的message字段

获取与某个产品绑定的APP(token)

GET /v3/product/apps/

请求参数

参数名 类型 必须 说明
product string 产品ID

返回值

  1. {
  2. "meta":{
  3. "message":"APP列表",
  4. "code":0
  5. },
  6. "data":{
  7. "count":1,
  8. "next":null,
  9. "previous":null,
  10. "results":[
  11. {
  12. "appid":"07f21838-20ed-11e7-a554-fa163e876164",
  13. "name":"test041401"
  14. }
  15. ]
  16. }
  17. }

字段说明

字段名 类型 必须
appid string APP ID
name string APP名字

错误码

错误代码 错误说明
29010 参数错误:具体内容查看Response的message字段

获取Web后台用户的MQTT信息(token)

GET /v3/accounts/mqtt/

请求参数

返回值

  1. {
  2. "meta":{
  3. "message":"mqtt info",
  4. "code":0
  5. },
  6. "data":{
  7. "loginname":"1b6fc9ee33f311e7bc70dc536017523b/1f578b6e33f311e79193dc536017523b",
  8. "clientid":"1f578b6e33f311e79193dc536017523b",
  9. "endpoint":"1b6fc9ee33f311e7bc70dc536017523b",
  10. "wssport":1883,
  11. "password":"D40c+22SnIJB6gbzWvLot2bgfABJMoO8lz95Iu0Pzbs=",
  12. "wsshost":"1b6fc9ee33f311e7bc70dc536017523b.mqtt.iot.gz.baidubce.com"
  13. }
  14. }

字段说明

字段名 类型 必须
loginname string MQTT登录用户名
password string MQTT登录密码
endpoint string MQTT实例ID
clientid string MQTT clientid
wsshost string MQTT Websocket host
wssport int MQTT Websocket port

错误码

错误代码 错误说明
29010 参数错误:具体内容查看Response的message字段

Web后台获取虚拟用户或虚拟设备的MQTT信息(token)

GET /v3/product/virtual/mqtt/

请求参数

参数名 类型 必须 说明
fog_id string 虚拟设备ID或虚拟用户ID
req_type int 请求类型:0→虚拟用户,1→虚拟设备

返回值

  1. {
  2. "meta":{
  3. "message":"MQTT信息",
  4. "code":0
  5. },
  6. "data":{
  7. "loginname":"1b6fc9ee33f311e7bc70dc536017523b/1f578b6e33f311e79193dc536017523b",
  8. "wsshost":"1b6fc9ee33f311e7bc70dc536017523b.mqtt.iot.gz.baidubce.com",
  9. "clientid":"1f578b6e33f311e79193dc536017523b",
  10. "endpoint":"1b6fc9ee33f311e7bc70dc536017523b",
  11. "password":"9DdIrYzmAu9ooTzgm0ImB3F3BykZg7u8p2nYjxSyVOo=",
  12. "wssport":8884
  13. }
  14. }

字段说明

字段名 类型 必须
loginname string MQTT登录用户名
password string MQTT登录密码
endpoint string MQTT实例ID
clientid string MQTT clientid
wsshost string MQTT Websocket host
wssport int MQTT Websocket port

错误码

错误代码 错误说明
29010 参数错误:具体内容查看Response的message字段

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注