设备管理：新增、删除、修改、查询_App端接入

添加设备

将设备添加至VSaaS。

请求

HTTP request (GraphQL)

POST https://vsaas-domain/vsaas/api/v1/be/

GraphQL Schema definition

mutation {

create_device(parameters)

}

参数

Header

Authorization : JWT or Bearer {access token}

Content-Type : application/json

Required

参数名	类型	必选	说明
udid	String	是	设备的udid
nickname	String	是	设备名
color_tag	String	是	颜色标签，用以UI呈现
thumbnail	String	是	缩略图，无的
channel	Int	是	通道数
credential	String	是	设备的秘钥，不同版本，创建的方式不一样。 SDK 4.x ：由设备端调用SDK API创建。 SDK 3.x ：一般是由authkey(ak)、identity(identity) 、av password(av)和authType(authType)产生，然后经过base64编码得到。authType 可以使用authPass 或者authToken，取决于设备端。如果设备端没有使用authkey，则authkey字段可以为空，对应的格式为：base64({"av":"888888","ak":"00000000","identity":"admin","authType":"authToken"})。
uid	String	否	设备UID，旧版本20位。
fw_ver	String	否	固件版本

Response

参数	类型	说明
stoken	String	APP端获取到此stoken后，需通过P2P SDK发送给设备端保存，用以设备端推流使用。

Code

200

400

例子

请求

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/

{    
"data": {
        "create_device": "aasdfawjlekjlkjxlkjcoijijkl"
    }
}

查询设备

查询设备列表

请求

GET /vsaas/api/v1/be?query={{get_device_list(udid:String) [Device]}

POST https://vsaas-domain/vsaas/api/v1/be/

参数

Header

Authorization : JWT or Bearer {access token}

Content-Type : application/json

Required

参数	类型	必选	说明
udid	String	否	指定udid的信息，如不带此字段，则查询所有的设备。

Response

参数	类型	说明
created	String	创建时间
updated	String	更新时间
udid	String	设备UDID
account	String	账户
vendor	String	厂商
nickname	String	设备名称
color_tag	String	颜色标签
thumbnail	String	缩略图
channel	Int	通道数
st	String	stoken
credential	String	秘钥，base64编码
fw_ver	String	固件版本
contracts	Contract	方案
contractInUse	Contract	当前方案
shareTo	DeviceSharingInfo	共享 account: string email: string phone: string name: string credential: string permission: int state: int startTime: string

Code

200

400

例子

请求

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/

{
    "data": {
        "get_device_list": [
        {                
            "udid":"588feadd",            
        },
        {
            ...
        }
        ]
    }
}

修改设备

请求

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 /vsaas/api/v1/be/

参数

Header

Authorization : JWT or Bearer {access token}

Content-Type : application/json

Required

参数	类型	必选	说明
udid	String	是	指定udid的信息
nickname	String	否	设备名
color_tag	String	否	颜色标签，用以UI呈现
thumbnail	String	否	缩略图
channel	Int	否	通道数
credential	String	否	设备的秘钥，不同版本，创建的方式不一样。 SDK 4.x ：由设备端调用SDK API创建。 SDK 3.x ：一般是由authkey(ak)、identity(identity) 、av password(av)和authType(authType)产生，然后经过base64编码得到。authType 可以使用authPass 或者authToken，取决于设备端。如果设备端没有使用authkey，则authkey字段可以为空，对应的格式为：base64({"av":"%s","ak":"%s","identity":"%s","authType":"authToken"})。
uid	String	否	设备UID，旧版本20位。
fw_ver	String	否	固件版本

Reponse

参数	类型	说明
data	json object

Code

200

400

例子

请求

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/

{
    "data": 
    {
        "update_device":"success"
    }
}

删除设备

请求

GET /vsaas/api/v1/be?query=mutation+{remove_device(udid:String!)}

POST /vsaas/api/v1/be/

参数

Header

Authorization : JWT or Bearer {access token}

Content-Type : application/json

Required

参数	类型	必选	说明
udid	String	是	指定udid

Response

参数	类型	说明
data	json object

Code

200

400

例子

请求

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/

设备管理：新增、删除、修改、查询

添加设备

请求

HTTP request (GraphQL)

GraphQL Schema definition

参数

Header

Required

Response

Code

例子

请求

回复

查询设备

请求

参数

Header

Required

Response

Code

例子

请求

回复

修改设备

请求

参数

Header

Required

Reponse

Code

例子

请求

回复

删除设备

请求

参数

Header

Required

Response

Code

例子

请求

回复