日日摸夜夜添夜夜爽出水_dvd碟片色爱_麻豆wwwcom内射软件_国产欧美色一区二区三区_中字幕视频在线永久在线观看免费_99久久在线视频精品店_国产精品1区2区3区在线观看 _两性午夜色视频免费网站_国产精品女同久久久久电影院_国产一区二区不卡亚洲涩情

簡體中文

[設備管理] 新增、刪除、修改、查詢

設備相關(guān) API 文檔

一、接口總覽

接口名稱功能描述請求方式授權(quán)方式接口版本
添加設備（create_device）將設備添加至VSaaS平臺，完成設備注冊入庫POST (GraphQL)JWT / Bearer Token 授權(quán)v1
查詢設備列表（get_device_list）查詢當前賬戶下的設備列表，支持按UDID篩選GET / POST (GraphQL)JWT / Bearer Token 授權(quán)v1
修改設備（update_device）更新已注冊設備的基本信息（名稱、標簽等）GET / POST (GraphQL)JWT / Bearer Token 授權(quán)v1
刪除設備（remove_device）從VSaaS平臺刪除指定UDID的設備GET / POST (GraphQL)JWT / Bearer Token 授權(quán)v1
本章節(jié)介紹TUTK VSaaS平臺設備管理核心API接口（GraphQL版本），第三方系統(tǒng)可通過這些接口完成設備添加、查詢、修改、刪除等操作，所有接口均需攜帶有效的VSaaS Token完成身份認證。

二、添加設備接口（create_device）

將設備添加至VSaaS平臺，完成設備的注冊入庫。需傳遞設備UDID、名稱、顏色標簽等必填參數(shù)，參數(shù)為空或格式錯誤會返回400參數(shù)錯誤。
（一）請求說明
1. 請求URL
POST: https://vsaas-domain/vsaas/api/v1/be/ 
2. GraphQL Schema 定義
mutation {  create_device(parameters) }
3. 請求頭（Header）
參數(shù)名類型必選說明
AuthorizationString是授權(quán)令牌，格式：JWT {token} 或 Bearer {token}
Content-TypeString是固定值：application/json
4. 請求參數(shù)
參數(shù)名類型必選位置說明
udidString是GraphQL參數(shù) MUTATION設備的UDID
nicknameString是GraphQL參數(shù) MUTATION設備名稱
color_tagString是GraphQL參數(shù) MUTATION顏色標簽，用以UI呈現(xiàn)（如#ffffff）
thumbnailString是GraphQL參數(shù) MUTATION縮略圖路徑，無則傳空字符串
channelInt是GraphQL參數(shù) MUTATION設備通道數(shù)
credentialString是GraphQL參數(shù) MUTATION設備的秘鑰，不同SDK版本創(chuàng)建方式不同： SDK 4.x：由設備端調(diào)用SDK API創(chuàng)建 SDK 3.x：由authkey(ak)、identity、av password(av)和authType組成，經(jīng)base64編碼得到。格式：base64({"av":"%s","ak":"%s","identity":"%s","authType":"authToken"})，authType支持authPass或authToken，設備端未使用authkey時ak字段可空
uidString否GraphQL參數(shù) MUTATION設備UID，舊版本為20位
fw_verString否GraphQL參數(shù) MUTATION設備固件版本
5. 請求示例（curl）
POST方式請求（示例）
curl -XPOST -H 'Authorization: Bearer LKdkjlk8873BNN' \ -H 'Content-Type: application/json' \ -d 'mutation {create_device(uid:"KJKWJK",udid:"KJKWJK",nickname:"LivingRoom",color_tag:"#ffffff",thumbnail:"a.jpg",channel:"0",credential:"adsfwefasdfa", fw_ver:"v0.0.0.1")}' \ https://vsaas.kalay.us/vsaas/api/v1/be/
（二）響應說明
1. 響應狀態(tài)碼
狀態(tài)碼徽章說明
200成功請求成功，設備添加完成
400參數(shù)錯誤請求參數(shù)錯誤（如UDID無效、必填參數(shù)缺失、credential格式錯誤）
401授權(quán)失敗授權(quán)令牌無效或過期
2. 響應參數(shù)說明
參數(shù)名類型說明
create_device（stoken）StringAPP端獲取到此stoken后，需通過P2P SDK發(fā)送給設備端保存，用以設備端推流使用
3. 響應示例（成功）
添加設備響應（示例）
{  "data": {    "create_device": "aasdfawjlekjlkjxlkjcoijijkl"  } }

三、查詢設備接口（get_device_list）

查詢當前賬戶下的設備列表，支持按設備UDID篩選指定設備信息，空參數(shù)則查詢?nèi)吭O備，支持GraphQL按需指定返回字段。
（一）請求說明
1. 請求URL
GET: /vsaas/api/v1/be?query=query {get_device_list(udid:String) [Device]} POST: https://vsaas-domain/vsaas/api/v1/be/ 
2. 請求頭（Header）
參數(shù)名類型必選說明
AuthorizationString是授權(quán)令牌，格式：JWT {token} 或 Bearer {token}
Content-TypeString是固定值：application/json
3. 請求參數(shù)
參數(shù)名類型必選位置說明
udidString否GraphQL參數(shù) QUERY指定設備UDID，不傳則查詢所有設備
4. 請求示例（curl）
POST方式請求（示例）
curl -XPOST -H 'Authorization: Bearer LKdkjlk8873BNN' \ -H 'Content-Type: application/json' \ -d 'query {get_device_list{udid,color_tag,channel,vendor,nickname,created,updated,channel,st,credential,fw_ver,contracts{pk},contractInUse{pk},shareTo{account}}}' \ https://vsaas.kalay.us/vsaas/api/v1/be/
（二）響應說明
1. 響應狀態(tài)碼
狀態(tài)碼徽章說明
200成功請求成功，返回設備列表
400參數(shù)錯誤請求參數(shù)錯誤（如GraphQL語法錯誤）
401授權(quán)失敗授權(quán)令牌無效或過期
2. 響應參數(shù)說明
參數(shù)名類型說明
createdString設備創(chuàng)建時間
updatedString設備信息更新時間
udidString設備UDID
accountString關(guān)聯(lián)賬戶標識
vendorString廠商ID
nicknameString設備名稱
color_tagString顏色標簽
thumbnailString縮略圖路徑
channelInt通道數(shù)
stString設備stoken
credentialString設備秘鑰（base64編碼）
fw_verString固件版本
contractsContract Object關(guān)聯(lián)的方案，包含pk字段（方案唯一標識）
contractInUseContract Object當前使用的方案，包含pk字段
shareToArray[DeviceSharingInfo]設備共享信息列表
DeviceSharingInfo 子參數(shù)
accountString共享賬戶標識
emailString共享賬戶郵箱
phoneString共享賬戶手機號
nameString共享賬戶姓名
credentialString共享憑證
permissionInt共享權(quán)限等級
stateInt共享狀態(tài)
startTimeString共享開始時間
3. 響應示例（成功）
查詢設備列表響應（示例）
{  "data": {    "get_device_list": [      {        "udid": "588feadd",        "nickname": "LivingRoom",        "color_tag": "#ffffff",        "channel": 0,        "vendor": "TUTK",        "created": "2024-01-01T00:00:00Z",        "updated": "2024-01-01T00:00:00Z",        "st": "aasdfawjlekjlkjxlkjcoijijkl",        "credential": "adsfwefasdfa",        "fw_ver": "v0.0.0.1",        "contracts": [{"pk": "5c6e7a311d41c87815d585ed"}],        "contractInUse": {"pk": "5c6e7a311d41c87815d585ed"},        "shareTo": [{"account": "user123", "email": "user@example.com", "phone": "13800138000", "name": "Test User", "credential": "share_cred", "permission": 1, "state": 1, "startTime": "2024-01-01T00:00:00Z"}]      },      {        "udid": "699febee",        "nickname": "BedRoom",        "color_tag": "#ff0000",        "channel": 0,        "vendor": "TUTK",        "created": "2024-01-02T00:00:00Z",        "updated": "2024-01-02T00:00:00Z",        "st": "bsdfawjlekjlkjxlkjcoijijkl",        "credential": "bsdfwefasdfa",        "fw_ver": "v0.0.0.1",        "contracts": [],        "contractInUse": null,        "shareTo": []      }    ]  } }

四、修改設備接口（update_device）

更新已注冊設備的基本信息（名稱、顏色標簽、縮略圖、秘鑰等），需傳遞設備UDID作為唯一標識，其余參數(shù)為可選修改項。
（一）請求說明
1. 請求URL
GET: /vsaas/api/v1/be?query=mutation {update_device(udid:String!,nickname:String,color_tag:String,uid:String,channel:Int,pw:String,credential:String,fw_ver:String)} POST: https://vsaas-domain/vsaas/api/v1/be/ 
2. 請求頭（Header）
參數(shù)名類型必選說明
AuthorizationString是授權(quán)令牌，格式：JWT {token} 或 Bearer {token}
Content-TypeString是固定值：application/json
3. 請求參數(shù)
參數(shù)名類型必選位置說明
udidString是GraphQL參數(shù) MUTATION指定要修改的設備UDID
nicknameString否GraphQL參數(shù) MUTATION設備名稱（可選修改）
color_tagString否GraphQL參數(shù) MUTATION顏色標簽（可選修改）
thumbnailString否GraphQL參數(shù) MUTATION縮略圖路徑（可選修改）
channelInt否GraphQL參數(shù) MUTATION設備通道數(shù)（可選修改）
credentialString否GraphQL參數(shù) MUTATION設備的秘鑰（可選修改），創(chuàng)建規(guī)則同添加設備接口
uidString否GraphQL參數(shù) MUTATION設備UID（可選修改，舊版本為20位）
fw_verString否GraphQL參數(shù) MUTATION設備固件版本（可選修改）
pwString否GraphQL參數(shù) MUTATION設備密碼（可選修改）
4. 請求示例（curl）
POST方式請求（示例）
curl -XPOST -H 'Authorization: Bearer LKdkjlk8873BNN' \ -H 'Content-Type: application/json' \ -d 'mutation {update_device(udid:"KJKWJK",nickname:"ResetRoom",color_tag:"#ff00ff")}' \ https://vsaas.kalay.us/vsaas/api/v1/be/
（二）響應說明
1. 響應狀態(tài)碼
狀態(tài)碼徽章說明
200成功請求成功，設備信息修改完成
400參數(shù)錯誤請求參數(shù)錯誤（如UDID不存在、參數(shù)格式錯誤）
401授權(quán)失敗授權(quán)令牌無效或過期
2. 響應參數(shù)說明
參數(shù)名類型說明
dataJSON Object響應主體，包含修改結(jié)果提示
update_deviceString修改結(jié)果提示（如"success"表示成功）
3. 響應示例（成功）
修改設備響應（示例）
{  "data": {    "update_device": "success"  } }

五、刪除設備接口（remove_device）

從VSaaS平臺刪除指定UDID的設備，解除設備與賬戶的關(guān)聯(lián)，需傳遞設備UDID作為唯一標識，該參數(shù)為空或不存在會返回400參數(shù)錯誤。
（一）請求說明
1. 請求URL
GET: /vsaas/api/v1/be?query=mutation {remove_device(udid:String!)} POST: https://vsaas-domain/vsaas/api/v1/be/ 
2. 請求頭（Header）
參數(shù)名類型必選說明
AuthorizationString是授權(quán)令牌，格式：JWT {token} 或 Bearer {token}
Content-TypeString是固定值：application/json
3. 請求參數(shù)
參數(shù)名類型必選位置說明
udidString是GraphQL參數(shù) MUTATION指定要刪除的設備UDID
4. 請求示例（curl）
POST方式請求（示例）
curl -XPOST -H 'Authorization: Bearer LKdkjlk8873BNN' \ -H 'Content-Type: application/json' \ -d 'mutation {remove_device(udid:"KJKWJK")}' \ https://vsaas.kalay.us/vsaas/api/v1/be/
（二）響應說明
1. 響應狀態(tài)碼
狀態(tài)碼徽章說明
200成功請求成功，設備刪除完成
400參數(shù)錯誤請求參數(shù)錯誤（如UDID不存在、UDID格式無效）
401授權(quán)失敗授權(quán)令牌無效或過期
2. 響應參數(shù)說明
參數(shù)名類型說明
dataJSON Object響應主體，包含刪除結(jié)果提示
remove_deviceString刪除結(jié)果提示（如"success"表示成功）
3. 響應示例（成功）
刪除設備響應（示例）
{  "data": {    "remove_device": "success"  } }

即刻開啟您的物聯(lián)網(wǎng)之旅

聯(lián)系解決方案專家
Kalay App
資訊安全白皮書
全球?qū)＠季?/a>
解決方案
新聞動態(tài)
公司動態(tài)
行業(yè)資訊
媒體報道
永續(xù)發(fā)展
經(jīng)營者的話
社會參與
環(huán)境永續(xù)
公司治理

+86 755 27702549

7×24小時服務熱線

法律聲明 隱私權(quán)條款

關(guān)注“TUTK”

TUTK服務盡在掌握

? 2022 物聯(lián)智慧科技（深圳）有限公司版權(quán)所有粵ICP備14023641號
在線咨詢
掃一掃

TUTK服務盡在掌握

全國免費服務熱線
+86 755 27702549

返回頂部