术语/缩写	含义
OpenApi	对外开发的功能接口，api接口平台域名：api-smbcloud.tplinkcloud.com.cn
TUMS云	TP-LINK商用云平台
SDK	TP-LINK开发者工具套件。
签名字符串	指待签名的字符串
签名	指签名计算的结果
Relay	对接入TUMS云的设备进行码流转发的服务器
RTSP	实时串流协议（Real Time Streaming Protocol，RTSP）是一种网络应用协议，专为娱乐和通信系统的使用，以控制流媒体服务器。该协议用于建立和控制终端之间的媒体会话。媒体服务器的客户端发布VCR命令，例如播放，录制和暂停，以便于实时控制从服务器到客户端（视频点播）或从客户端到服务器（语音录音）的媒体流。
HLS	HTTP Live Streaming（缩写是HLS）是一个由苹果公司提出的基于HTTP的流媒体网络传输协议。
TP-LINK ID	使用用户手机或者邮箱注册的TP-LINK账号
企业	用于管理TP-LINK ID下所有设备商用功能逻辑单位；拥有权限控制、用户管理、设备管理等功能。单个TP-LINK ID在TUMS云仅能创建唯一企业
项目	用户可以为企业创建项目逻辑单位
子账户	在企业中，管理者为企业其他使用者创建的账号；该账号仅在企业内部使用。
角色	企业中用于管理项目的各类操作权限的实体，可与用户进行关联，使用户具有该角色的权限

开发前准备

开发前需要先获取TUMS云对接的身份认证信息，AK/SK；平台会通过AK/SK认证方式来验证请求发送者的身份。

开发者平台使用流程：

获取AK/SK（开发者密钥）流程

签名计算流程：

注：

1. sha256Hex：java对应算法实例为java.security.MessageDigest.getInstance("SHA-256")，签名计算完成后将byte数组转换成16进制小写字符串格式。

2. hmac256：java对应算法实例为javax.crypto.Mac.getInstance("HmacSHA256")，hmac256(key,value)接受两个参数，第一个为加密key，第二个为待加密的值。

3. 签名步骤中各参数含义：

参数名	含义
TerminalId	区分用户客户端唯一标识，可传设备序列号、网卡mac地址等、也可使用UUID（同一客户端上生成一次UUID并保存下来作为标识）（一些场景下，服务端会根据此字段保存与客户端相关联的上下文信息），长度32-64位。
Timestamp	unix时间戳，是指从1970年1月1日（UTC/GMT的午夜）开始所经过的秒数，不考虑闰秒。
Nonce	number used once或Number once的缩写，Nonce是一个只被使用一次的任意或非重复的随机数值，可使用UUID生成，长度32位。
X-Authorization	请求中用于验证的请求头字段名称
Signature	签名值

开发者平台 / TP-LINK商用管理系统（TUMS）/ 对接开发

对接开发

签名示例：

示例请求：

请求方法及路径：
POST https://api-smbcloud.tplinkcloud.com.cn/tums/console/v1/getEnterpriseResourceSummary
请求内容（Payload）:
{"enterpriseId":"5"}

签名计算步骤：

1. 获取AK、SK：

AK:"NTkzYTBkMjAwMDAwMDAwMDI2MTQ5YjQ="
SK:"bedea4fd64254b079c1124c8af06fd90"

2. 获取客户端id （terminalId）、当前时间戳timestamp、随机字符串nonce

terminalId:"BFEBFBFF000906EA"
timestamp:"1653280395"
nonce:"2c05c2fffc4143d18337d78ff257ae63"

3. 请求方法method、请求路径path、请求内容payload

method:"POST"
path:"/tums/console/v1/getEnterpriseResourceSummary"
payload:"{\"enterpriseId\":\"5\"}"

4. 使用SHA256计算payload签名sha256Hex(payload)：

hashedCanonicalRequest:"d9f730489e442c5b97ede7f68bb9dc3d510c027f21b1f54e291cd4cafd447b03"

5. 拼接credentialScope：

credentialScope:
"POST /tums/console/v1/getEnterpriseResourceSummary tp-link_request"

6. 构造待签名字符串：

stringToSign:
"HmacSHA256\n
1653280395\n
POST /tums/console/v1/getEnterpriseResourceSummary tp-link_request\n
d9f730489e442c5b97ede7f68bb9dc3d510c027f21b1f54e291cd4cafd447b03"

7. 计算时间戳签名（字节数组无法直接打印，以下展示的是字节数组转换为16进制字符串后的值）：

byte[] secretDate:[7FFC68EB6F71334D08B468B75CD0B71AADE40F5EDE333018DC4CC70E6DDF74A9]

8. path签名串（字节数组无法直接打印，以下展示的是字节数组转换为16进制字符串后的值）：

byte[]secretService:
[2F263764DFF7E31944F65BC6B4522688119B3814D3EDEAF8E39362538DF66094]

9. tp-link签名secretSigning（字节数组无法直接打印，以下展示的是字节数组转换为16进制字符串后的值）：

byte[]secretSigning:
[E007D3D505D39F912F1A7F271B98979979F97FC66B2221BED3A318CE2F2639ED]

10. 最终签名byte数组（字节数组无法直接打印，以下展示的是字节数组转换为16进制字符串后的值）和转换为小写16进制字符格式的值：

byte[]finalSign:
[DE1C8A0095A0CACD5AD5770867B1C2685D01D0E164408B2E0998EA5DF4C24096]
finalSignString:
"de1c8a0095a0cacd5ad5770867b1c2685d01d0e164408b2e0998ea5df4c24096"

11. 最终的请求头：

"X-Authorization":"Timestamp=1653280395,Nonce=2c05c2fffc4143d18337d78ff257ae63,AccessKey=NTkzYTBkMjAwMDAwMDAwMDI2MTQ5YjQ=,Signature=de1c8a0095a0cacd5ad5770867b1c2685d01d0e164408b2e0998ea5df4c24096,TerminalId=BFEBFBFF000906EA"

开发者平台 / TP-LINK商用管理系统（TUMS）/ 对接开发（前端）

对接开发（前端）

签名计算流程中涉及的加密算法，推荐使用crypto-js开源库。

签名示例：

示例请求：

请求方法及路径：
POST https://api-smbcloud.tplinkcloud.com.cn/tums/console/v1/getEnterpriseResourceSummary
请求内容（Payload）：
{"enterpriseId":"5"}

签名计算步骤：

1. 获取AK、SK：

AK: "NTkzYTBkMjAwMDAwMDAwMDI2MTQ5YjQ="
SK: "bedea4fd64254b079c1124c8af06fd90"

2. 获取客户端id （terminalId）、当前时间戳timestamp、随机字符串nonce

terminalId: "BFEBFBFF000906EA"
timestamp: "1653280395"
nonce: "2c05c2fffc4143d18337d78ff257ae63"

3. 请求方法method、请求路径path、请求内容payload

method: "POST"
path: "/tums/console/v1/getEnterpriseResourceSummary"
payload: "{\"enterpriseId\":\"5\"}"

4. 使用SHA256计算payload签名sha256Hex(payload)：

let hashedCanonicalRequest = Crypto.SHA256(payload).toString(); "d9f730489e442c5b97ede7f68bb9dc3d510c027f21b1f54e291cd4cafd447b03"

5. 拼接credentialScope：

let credentialScope = `${method} ${path} tp-link_request`;
"POST /tums/console/v1/getEnterpriseResourceSummary tp-link_request"

6. 构造待签名字符串：

let stringToSign = `HmacSHA256\n${timestamp}\n${credentialScope}\n${hashedCanonicalRequest}`;
"HmacSHA256\n
1653280395\n
POST /tums/console/v1/getEnterpriseResourceSummary tp-link_request\n
d9f730489e442c5b97ede7f68bb9dc3d510c027f21b1f54e291cd4cafd447b03"

7.计算时间戳签名：

let secretDate = Crypto.HmacSHA256(timestamp, SK).toString(); "7FFC68EB6F71334D08B468B75CD0B71AADE40F5EDE333018DC4CC70E6DDF74A9"

8.path签名串：

let secretService = Crypto.HmacSHA256(path, secretDate).toString();
"2F263764DFF7E31944F65BC6B4522688119B3814D3EDEAF8E39362538DF66094"

9.tp-link签名secretSigning：

let secretSigning = Crypto.HmacSHA256('tp-link', secretService);
"E007D3D505D39F912F1A7F271B98979979F97FC66B2221BED3A318CE2F2639ED"

10. 最终签名字符串：

let finalSign = Crypto.HmacSHA256(stringToSign, secretService); "de1c8a0095a0cacd5ad5770867b1c2685d01d0e164408b2e0998ea5df4c24096"

11. 最终的请求头：

let authorization = `Timestamp=${timestamp},Nonce=${nonce},AccessKey=${AK},Signature=${finalSign},TerminalId=${terminalId}`;
请求头：
"X-Authorization":"Timestamp=1653280395,Nonce=2c05c2fffc4143d18337d78ff257ae63,AccessKey=NTkzYTBkMjAwMDAwMDAwMDI2MTQ5YjQ=,Signature=de1c8a0095a0cacd5ad5770867b1c2685d01d0e164408b2e0998ea5df4c24096,TerminalId=BFEBFBFF000906EA"

接口规则

接口规则	描述
传输方式	仅支持HTTPS传输
url规则	url格式：https://{hostname}:{port}{path}。 hostname：平台的IP地址或域名。商用云平台开发者平台开发者域名为api-smbcloud.tplinkcloud.com.cn。 port：平台的web访问端口，https协议默认为443。 path：API接口的path，每个API都有唯一的path，详见API的接口定义。
提交方式	除特殊说明的接口外，均采用POST方法提交
请求内容格式	除特殊说明的接口外，提交和返回的数据均为JSON格式
字符编码	统一采用UTF-8字符编码
安全认证	提供了基于AK/SK的安全认证方案。只有认证通过，才能正常访问每一个API。
权限控制	每个api访问的接口受AK/SK账户的权限管控，使用AK/SK与该用户拥有相同的访问权限。
返回值	见返回值说明一节内容

调用认证

2.2.1 AK\SK摘要认证

本平台的接口安全认证，使用普遍被各大开放平台使用的AK/SK安全认证方案。如果业务API需要安全认证，用户在调用 API 时，首先需要获取API的授权，得到AppKey和AppSecret；其次，计算和拼接签名字符串，将计算后的签名放在请求的 Header 传入，TUMS API网关会通过核对计算签名来验证请求者的身份。

2.2.2 名词解释

术语	含义
Http Method	http请求的方法，常用的方法有GET/POST/PUT/DELETE等。
请求headers（Request Headers）	http请求中的头信息。
path	http请求路径，指域名/IP（端口号）之后的部分，如请求地址为"api-smbcloud.tplinkcloud.com.cn/ tums/resource/v2/getEnterpriseList"，则path指"/ tums/resource/v2/getEnterpriseList "。
query	指请求地址中的参数，如请求地址为"api-smbcloud.tplinkcloud.com.cn/ tums/resource/v2/getEnterpriseList?a=b&c=d"，query为a:b,c:d。
Payload	指POST请求内容，通常以键值对存在的参数。一般为json格式
AppKey/AppSecret	即对应AK/SK。一对AppKey/AppSecret用于标识一个调用方，AppSecret作为密钥参与签名计算。
签名字符串	指待签名计算的字符串
签名	指签名计算的结果，为字符串

返回值说明

对于API接口调用返回的结果，除有特殊说明外，统一采用json格式，错误码使用小写下划线格式，结果内容字段采用驼峰式方法命名,返回的接口内容格式如下

{
  "error_code": //错误码
  "msg": //错误码描述
  "result": //返回详细数据
}

返回字段	含义描述
error_code	错误码值，0代表业务正常处理
msg	错误码的描述，error_code非0时返回
result	业务的详细数据返回，error_code为0时返回

设备管理相关字段取值表格

表1 设备类型枚举值列表

设备MIC类型	说明
SMBWIRELESSROUTER, SMBROUTER,WIRELESSROUTER	路由器（router）
SMARTSWITCH, L3MANAGEDSWITCH, L2MANAGEDSWITCH, L1-CHASSISSWITCH, L2-CHASSISSWITCH	交换机（switch）
AC	AC
AP, WALLJACKAP, CEILINGMOUNTAP, DESKTOPAP, OUTDOORAP,SMARTHOME.SMBAP, INDUSTRIALAP,STICKAP	AP
CPE, BSCPE, MOTORCPE, IPCCPE, CPEBS, INDUSTRIALCPE	网桥（cpe）
SMBFIREWALL	防火墙（firewall）
SMBFIBERCONVERTER	光纤收发器（fiberConverter）
NETWORKVIDEORECORDER	NVR（nvr）
SURVEILLANCECAMERA	IPC（ipc）
NETWORKVIDEODECODER	解码器（decoder）
SMB.WALLPLUGSENSOR	SMB 插墙式Sensor
SMB.PONOLT	OLT
SMB.PONONU	ONU

表2 设备状态枚举值列表

设备状态	说明
0	离线
1	在线
2	重启中
3	升级中
4	配置中
5	同步中
6	等待升级

表3 工作模式枚举值列表

枚举值	说明
1	ap
2	client
3	repeater
4	bridge
5	router
6	wisp

表4 设备列表字段枚举值列表

枚举值	说明
deviceName	设备名称
deviceType	设备类型
deviceStatus	设备状态
deviceModel	设备型号
ip	ip地址
mac	mac地址
parentDeviceName	关联设备名称
regionName	所属分组
operationMode	工作模式
ledStatus	LED状态
ipcNum	通道数
connectedIpcNum	已接入IPC
location	安装位置
projectName	所属项目
firmwareVer	软件版本
hardwareVer	硬件版本
locationName	地理位置名称

表5 太阳能供电系统状态字段枚举值列表

枚举值	说明
0	不在充电状态
1	充电中状态
2	充电完成状态
3	智能辅热状态
4	低温保护：禁止充电
5	低温保护：禁止充电、放电
6	高温保护：禁止充电
7	高温保护：禁止充电、放电

消息订阅相关字段取值表格

表6 订阅消息定义

名称	内容
devId string	【必填】当前设备索引。
deviceName string	【必填】设备名称（别名）。
msgId string	【选填】消息的唯一标识，由消息源端保证唯一性。
time number	【必填】消息产生时的UTC时间戳，消息如果重复发送，该时间保持不变。单位秒。
msgType string	【必填】消息类型，详细定义详见表格1-9msgType字段
msgContentType array<string>	【必填】描述具体消息，详细定义详见表格1-10 msgContentType。

发出的请求示例如下：

POST https://www.vmscloud.com/receive/msg 
Content-Type: application/json
{"devId":"3","deviceName":"TL-IPC43AN","msgId":"123","time":"1609135966","msgType":"vmsDeviceAlarm","msgContentType":[" vmsDeviceOffline"]}

表7 msgType定义

msgType	消息类型描述	msgType	消息类型描述
monitorAlarm	监控点报警	nmsDeviceAlarm	网络设备报警
vmsDeviceAlarm	安防设备报警	chargingStationDeviceAlarm	充电桩设备报警

表8 msgContentType定义

监控点报警（monitorAlarm）

msgContentType	事件描述	msgContentType	事件描述
timing	定时报警	wanderingDetected	徘徊侦测报警
movementDetected	移动侦测报警	crowdDetected	人员聚集报警
shadeDetected	视频遮挡报警	fastMoving	快速移动报警
overstepingBoundaryDetected	越界侦测报警	parkingDetected	停车侦测报警
areaIntruded	区域入侵报警	itemsLeftBehind	物品遗留报警
enterArea	进入区域报警	itemsTaken	物品拿取报警
leaveArea	离开区域报警	audioAbnormal	音频异常报警
defocusDetected	虚焦侦测报警	sceneChanged	场景变更报警
faceDetected	人脸侦测报警	externalDeviceAlarm	外接设备报警
videoLost	视频信号丢失报警	videoMessage	视频留言报警
humanDetected	人形检测报警	vehicleDetected	车辆检测报警
itemsLeftAndTaken	物品遗留拿取报警	cryDetected	哭声检测报警
highAltitudeThrowing	高空抛物报警	electromobileDetected	电瓶车检测报警
someBodyPass	有人经过报警	videoRecover	视频信号恢复

安防设备报警（vmsDeviceAlarm）

msgContentType	事件描述	msgContentType	事件描述
nvrDeviceOnline	NVR设备上线	nvrDeviceOffline	NVR设备下线
ipcDeviceOnline	IPC设备上线	ipcDeviceOffline	IPC设备下线
vpsDeviceOnline	VPS设备上线	vpsDeviceOffline	VPS设备下线
decoderDeviceOnline	解码器设备上线	decoderDeviceOffline	解码器设备下线
nbsSpeakerDeviceOnline	网络音箱设备上线	nbsSpeakerDeviceOffline	网络音箱设备下线
SDCardLost	SD卡丢失报警	SDCardFull	SD卡满报警
NVRHardDiskLost	NVR硬盘缺失报警	NVRHardDiskFull	NVR硬盘满报警
SDCardAbnormal	SD异常报警	NVRHardDiskAbnormal	NVR硬盘异常报警
abnormalLogin	异常登录报警	PoEPortAbnormal	PoE端口异常报警
PoEPortPowerOverLimit	PoE单端口功率超限报警	PoEChipTemperatureAbnormal	PoE芯片温度异常报警
PoETotalPowerOverLimit	PoE总功率超限报警	flowExceedsThreshold	流量超出阈值报警

网络设备报警（nmsDeviceAlarm）

msgContentType	事件描述	msgContentType	事件描述
cpeDeviceOnline	网桥设备上线	cpeDeviceOffline	网桥设备下线
acDeviceOnline	AC设备上线	acDeviceOffline	AC设备下线
apDeviceOnline	AP设备上线	apDeviceOffline	AP设备下线
switchDeviceOnline	交换机设备上线	switchDeviceOffline	交换机设备下线
firewallDeviceOnline	防火墙设备上线	firewallDeviceOffline	防火墙设备下线
routerDeviceOnline	路由器设备上线	routerDeviceOffline	路由器设备下线
fiberConverterDeviceOnline	云光纤设备上线	fiberConverterDeviceOffline	云光纤设备下线
oltDeviceOnline	OLT设备上线	oltDeviceOffline	OLT设备下线
onuDeviceOnline	ONU设备上线	onuDeviceOffline	ONU设备下线
networkControllerDeviceOnline	NAC设备上线	networkControllerDeviceOffline	NAC设备下线
nmsOtherException	其他异常报警	nmsAccessException	接入异常报警
nmsConfigException	配置异常报警	nmsDeviceException	网络设备异常报警
nmsNetworkSafety	网络安全报警	nmsSystemUpgrade	网络设备系统升级报警
nmsDeviceOperate	网络设备配置操作报警	nmsAdjust	射频调优消息
nmsAbnormalPort	端口异常消息	nmsTerminalException	终端异常报警

充电设备报警(chargingStationDeviceAlarm)

msgContentType	事件描述
chargingHubDeviceOnline	充电桩设备上线
chargingHubDeviceOffline	充电桩设备下线
solarPowerDeviceOnline	太阳能设备上线
solarPowerDeviceOffline	太阳能设备下线
spearheadConnectionAbnormalDetected	枪头连接异常
meterCommunicationFailureDetected	电表通信异常
relayFailureDetected	继电器失效
temperatureLowDetected	端口温度过低
temperatureHighDetected	端口温度过高
leakageCurrentDetected	端口漏电流
overPowerDetected	端口功率过载
overVoltageDetected	输入过压
underVoltageDetected	输入欠压
overFrequencyDetected	输入过频
underFrequencyDetected	输入欠频
phaseSequenceAbnormalDetected	相序异常
downToEarthAbnormal	接地异常
insulationResistanceAbnormalDetected	绝缘阻抗异常
RTCTimeException	RTC时间异常
simInsufficientFlow	sim卡流量不足
outputPowerOverload	设备总功率过载
emergencyShutdown	设备紧急停机
shortCircuitException	短路异常
checkPointException	检测点异常
internalCommunicationException	设备内部通信异常

4. 错误码

错误码	描述

1.总览

通过TP-LINK商用云平台(简称商云)进行二次开发，您需要以下步骤：

1·注册商云
2·创建子账号
3·成为开发者
4·设备试用并接入
5·获取接口凭证
6·开发与测试
7·设备采购与部署
8·更多开发者服务

1·注册商云
2·创建子账号
3·成为开发者
4·设备试用并接入
5·获取接口凭证
6·开发与测试
7·设备采购与部署
8·更多开发者服务

1·注册商云
2·创建子账号
3·成为开发者
4·设备试用并接入
5·获取接口凭证
6·开发与测试
7·设备采购与部署
8·更多开发者服务

1·注册商云
2·创建子账号
3·成为开发者
4·设备试用并接入
5·获取接口凭证
6·开发与测试
7·设备采购与部署
8·更多开发者服务

1·注册商云
2·创建子账号
3·成为开发者
4·设备试用并接入
5·获取接口凭证
6·开发与测试
7·设备采购与部署
8·更多开发者服务

注册TP-LINK商用云平台账号，建立属于您的企业。该账号作为企业主，拥有超级管理员权限，能够支配账号内的所有设备及功能。

在【商云-成员】中创建更多成员子账号、并为这些子账号分配权限。不建议直接使用主账号进行开发，除非您允许开发者拥有企业的所有权限。

以子账号登录，在商云的开发者服务中开启密钥，获取该账号对应的AK/SK和AccessToken，这是对接商云的身份认证信息。基于此密钥进行二次开发时，将拥有与对应账号相同的权限。密钥与账号信息同样重要和敏感，请妥善保存。

大部分的商云开发者服务都依托于设备。请将TP-LINK设备联网并添加到商云中，并确保在商云上能正常使用设备、已将设备授权给开发者子账号。

1 购买TP-LINK设备，开机并插上网线

2 通过TP-LINK商云APP扫描机身上的二维码或通过TP-LINK商用云平台输入机身上的ID

1. accessToken校验

accessToken密钥：在有效期内，凭此令牌添加到请求url的参数中，即可直接调用接口。该方式使用起来更快捷，无需计算签名，但安全性相⽐AK/SK较低，存在token泄漏的风险。密钥的内容包含token字段、有效期(有效期为7天，起止时间精确到秒),到期后需要用户登录商云查看或通过开发者服务申请新的accessToken。
（注意每个用户同时最多只能有100个有效期内的accessToken）。

使用示例：

请求方法及路径：
POST https://api-smbcloud.tplinkcloud.com.cn/tums/console/v1/getEnterpriseResourceSummary?accessToken=0e9c58261e604a54a20fe0d284938b85
请求内容（Payload）：
{"enterpriseId":"5"}

2. 如果使用AK/SK，则需要先计算请求签名。计算流程如下

开始

获取ak/sk

获取客户端terminalId
获取时间戳timestamp
生成随机宇符串nonce

使用sha256计算payload的签名
得到签名字符串
hashedCanonicalRequest=sha256Hex(payload)

拼接credentialScope=
method + " " + path + " " + "tp-link_request"

构造签名串：
stringToSign = algorithm + "\n" + timeStamp + "\n" +
credentialscope + "\n" + hashedCanonicalRequest

计算时间戳签名串:
byte[] secretDate = hmac256((sk).getBytes(UTF8),timestamp);

计算path签名串：
byte [] secretService = hmac256(secretDate,path);

计算：
byte[]secretSigning = hmac256(secretService,"tp-link");

计算最终签名串：
byte[]finalSign = hmac256(secretSigning,stringTosign);

将签名串转换为hex小写宇符格式:
String signature = printHexBinary(finalSign).toLowerCase();

拼接请求头:
"X-Authorization": "Timestamp=timestamp:Nonce=nonce; AccessKey=ak;Signature=signature;TerminalId=termimalId"

结束

对于AK/SK鉴权方式的签名请求体，你可以登陆商用云平台web端进入密钥管理，使用签名计算器来辅助校验签名的正确性。

签名请求示例（前端）

请求方法及路径：
POST https://api-smbcloud.tplinkcloud.com.cn/tums/console/v1/getEnterpriseResourceSummary
请求内容（Payload）：
{"enterpriseId":"5"}

AK: "NTkzYTBkMjAwMDAwMDAwMDI2MTQ5YjQ="
SK: "bedea4fd64254b079c1124c8af06fd90"

terminalId: "BFEBFBFF000906EA"
timestamp: "1653280395"
nonce: "2c05c2fffc4143d18337d78ff257ae63"

method: "POST"
path: "/tums/console/v1/getEnterpriseResourceSummary"
payload: "{\"enterpriseId\":\"5\"}"

let hashedCanonicalRequest = Crypto.SHA256(payload).toString(); "d9f730489e442c5b97ede7f68bb9dc3d510c027f21b1f54e291cd4cafd447b03"

let credentialScope = `${method} ${path} tp-link_request`;
"POST /tums/console/v1/getEnterpriseResourceSummary tp-link_request"

let stringToSign = `HmacSHA256\n${timestamp}\n${credentialScope}\n${hashedCanonicalRequest}`;
"HmacSHA256
1653280395
POST /tums/console/v1/getEnterpriseResourceSummary tp-link_request
d9f730489e442c5b97ede7f68bb9dc3d510c027f21b1f54e291cd4cafd447b03"

let secretDate = Crypto.HmacSHA256(timestamp, SK).toString(); "7FFC68EB6F71334D08B468B75CD0B71AADE40F5EDE333018DC4CC70E6DDF74A9"

let secretService = Crypto.HmacSHA256(path, secretDate).toString();
"2F263764DFF7E31944F65BC6B4522688119B3814D3EDEAF8E39362538DF66094"

let secretSigning = Crypto.HmacSHA256('tp-link', secretService);
"E007D3D505D39F912F1A7F271B98979979F97FC66B2221BED3A318CE2F2639ED"

let finalSign = Crypto.HmacSHA256(stringToSign, secretSigning).toString(); "de1c8a0095a0cacd5ad5770867b1c2685d01d0e164408b2e0998ea5df4c24096"

let authorization = `Timestamp=${timestamp},Nonce=${nonce},AccessKey=${AK},Signature=${finalSign},TerminalId=${terminalId}`;
"X-Authorization":"Timestamp=1653280395,Nonce=2c05c2fffc4143d18337d78ff257ae63,AccessKey=NTkzYTBkMjAwMDAwMDAwMDI2MTQ5YjQ=,Signature=de1c8a0095a0cacd5ad5770867b1c2685d01d0e164408b2e0998ea5df4c24096,TerminalId=BFEBFBFF000906EA"

签名请求示例（后端）

请求方法及路径：
POST https://api-smbcloud.tplinkcloud.com.cn/tums/console/v1/getEnterpriseResourceSummary
请求内容（Payload）：
{"enterpriseId":"5"}

AK: "NTkzYTBkMjAwMDAwMDAwMDI2MTQ5YjQ="
SK: "bedea4fd64254b079c1124c8af06fd90"

terminalId: "BFEBFBFF000906EA"
timestamp: "1653280395"
nonce: "2c05c2fffc4143d18337d78ff257ae63"

method: "POST"
path: "/tums/console/v1/getEnterpriseResourceSummary"
payload: "{\"enterpriseId\":\"5\"}"

hashedCanonicalRequest： "d9f730489e442c5b97ede7f68bb9dc3d510c027f21b1f54e291cd4cafd447b03"

credentialScope:
"POST /tums/console/v1/getEnterpriseResourceSummary tp-link_request"

stringToSign:
"HmacSHA256
1653280395
POST /tums/console/v1/getEnterpriseResourceSummary tp-link_request
d9f730489e442c5b97ede7f68bb9dc3d510c027f21b1f54e291cd4cafd447b03"

byte [] secretDate:[7FFC68EB6F71334D08B468B75CD0B71AADE40F5EDE333018DC4CC70E6DDF74A9]

byte [] secretService:
[2F263764DFF7E31944F65BC6B4522688119B3814D3EDEAF8E39362538DF66094]

byte [] secretSigning:
[E007D3D505D39F912F1A7F271B98979979F97FC66B2221BED3A318CE2F2639ED]

byte [] finalSign:
[DE1C8A0095A0CACD5AD5770867B1C2685D01D0E164408B2E0998EA5DF4C24096]
finalSignString:
"de1c8a0095a0cacd5ad5770867b1c2685d01d0e164408b2e0998ea5df4c24096"

"X-Authorization":"Timestamp=1653280395,Nonce=2c05c2fffc4143d18337d78ff257ae63,AccessKey=NTkzYTBkMjAwMDAwMDAwMDI2MTQ5YjQ=,Signature=de1c8a0095a0cacd5ad5770867b1c2685d01d0e164408b2e0998ea5df4c24096,TerminalId=BFEBFBFF000906EA"

完成签名鉴权后，即可通过URL调用接口，对设备信息进行获取和编辑，享受商云功能。联调测试过程中返回的错误码，可在该网站中搜索。

经过以上试用、开发与调试，现在您可以大规模的进行TP-LINK设备采购与部署，并运营您的企业平台。

商云将不断完善，为开发者提供更多的数据分析、边缘计算、开发工具等服务，敬请期待。

SDK预览流程

目前SDK支持预览，回放和双向语音，它们的交互流程如下：

(1) SDK预览流程

其中：
1. ak-sk：代表平台间鉴权标记。
2. token_a：代表本地请求的预览画面凭证，标记此次预览/回放内容。
3. url_a：代表对外呈现的预览访问地址，该地址接口包含从request_relay开始的所有流程，sdk可直接通过此地址获取到relay服务参数和relay实际访问地址。 url_a示例：

https://tums-uat-hz.tp-link.com.cn/tums/relay/v1/sdk/requestRelayUrl?token=11179-e3NhbHQgPSAxNzg4NjAyMjU1O2NsaWVu-e172158b44cd4abfa0cc8823ad12ceaa&devInfoId=21000000757&clientUUID=3670de80-0eba-27db-87fa-e986879c43f1&clientType=chrome 103.0&streamType=video&resolution=2

4. url_b：代表relay实际的访问地址，sdk通过此地址与relay服务建立连接并进行拉流，url_b示例：

https://tums-hz-uat-relay1-webca-lb.tp-link.com.cn:443/sdk/cff3e3aa555b4c02846e2dbe7b47efc7/relayservice?sessionid=91dfc1d1e2f540179be914fed347e5f1&type=video&resolution=HD

由开发者后台携带ak，sk用户鉴权标记请求商云后台requestStreamUrl，获得商云提供的SDK预览URL，接着由SDK请求商云后台该URL，返回relay服务器地址，SDK与relay直接建立连接拉流预览播放。

(2) SDK回放流程

后台先调用搜索存在回放录像的日期接口查询设备存在回放录像的日期，以便用户选择有录像的日期然后点击回放。获取视频流的过程和SDK的预览流程相似，此处不再赘述。此外后台会调用搜索当天录像数据接口，并以此接口的返回值在下方进度条处显示录像数据时间段和对应的录像对应的事件类型。

(3) SDK双向语音流程

和SDK的预览流程相似，此处不再赘述。

预览回放相关字段取值表格

表9 eventType事件类型约束表

eventType	事件描述	eventType	事件描述
1	定时	2	移动侦测
3	遮挡侦测	4	越界侦测
5	区域入侵	6	进入区域
7	离开区域	8	徘徊侦测
9	人员聚集	10	快速移动
11	停车侦测	12	物品遗留
13	物品拿取	14	音频异常
15	虚焦侦测	16	场景变更
17	人脸侦测	18	报警
19	过线统计	20	登陆异常
21	SD卡满	22	SD卡错误
23	SD卡拔出	24	网线断开
25	IP冲突	26	人形检测
27	车辆侦测	28	物品遗漏拿取侦测
29	移动侦测云存	30	迎宾播报
31	视频留言	32	移动侦测人形加强
33	移动侦测车辆加强	34	区域入侵人形加强
35	区域入侵车辆加强	36	越界侦测人形加强
37	越界侦测车辆加强	38	人脸比对
39	人脸相册	40	进入区域人形加强
41	进入区域车辆加强	42	离开区域人形加强
43	离开区域车辆加强	44	客流量统计
45	门铃呼叫	46	人员到访
47	车位占用	48	哭声检测
49	人形相册	50	紧急呼救

表10 NVR videoType字段表

eventType	事件描述	eventType	事件描述
[1,0]	定时	[2,0]	移动侦测
[3,0]	定时和移动侦测

表11 IPC videoType字段表

eventType	事件描述	eventType	事件描述
[1,0]	定时	[2,0]	移动侦测
[4,0]	遮挡侦测	[8,0]	越界侦测
[16,0]	区域入侵	[32,0]	进入区域
[64,0]	离开区域	[128,0]	徘徊侦测
[256,0]	人员聚集	[512,0]	快速移动
[1024,0]	停车侦测	[2048,0]	物品遗留
[4096,0]	物品拿取	[8192,0]	音频异常
[16384,0]	虚焦侦测	[32768,0]	场景变更
[65536,0]	人脸侦测	[131072,0]	报警
[262144, 0]	过线统计	[524288, 0]	登陆异常
[1048576, 0]	SD卡满	[2097152, 0]	SD卡错误
[4194304, 0]	SD卡拔出	[8388608, 0]	网线断开
[16777216, 0]	IP冲突	[33554432, 0]	人形检测
[67108864, 0]	车辆侦测	[134217728, 0]	物品遗漏拿取侦测
[268435456, 0]	移动侦测云存	[536870912, 0]	迎宾播报
[1073741824, 0]	视频留言	[-2147483648, 0]	移动侦测人形加强
[0, 1, 0]	移动侦测车辆加强	[0, 2, 0]	区域入侵人形加强
[0, 4, 0]	区域入侵车辆加强	[0, 8, 0]	越界侦测人形加强
[0, 16, 0]	越界侦测车辆加强	[0, 32, 0]	人脸比对
[0, 64, 0]	人脸相册	[0, 128 0]	进入区域人形加强
[0, 256, 0]	进入区域车辆加强	[0, 512, 0]	离开区域人形加强
[0, 1024, 0]	离开区域车辆加强	[0, 2048, 0]	客流量统计
[0, 4096, 0]	门铃呼叫	[0, 8192, 0]	人员到访
[0, 16384, 0]	车位占用	[0, 32768, 0]	哭声检测
[0, 65536, 0]	人形相册	[0, 131072, 0]	紧急呼救

接口说明：

名称	内容
path
功能说明
使用限制	使用开发者认证方式访问

请求参数：

参数名称	参数描述
无	无

返回参数：

参数名称	参数描述
无	无

TP-LINK 商用云平台

相关术语

开发前准备

开发者平台使用流程：

获取AK/SK（开发者密钥）流程

签名计算流程：

对接开发

签名示例：

示例请求：

签名计算步骤：

对接开发（前端）

签名示例：

示例请求：

签名计算步骤：

接口规则

调用认证

2.2.1 AK\SK摘要认证

2.2.2 名词解释

返回值说明

设备管理相关字段取值表格

表1 设备类型枚举值列表

表2 设备状态枚举值列表

表3 工作模式枚举值列表

表4 设备列表字段枚举值列表

表5 太阳能供电系统状态字段枚举值列表

消息订阅相关字段取值表格

表6 订阅消息定义

表7 msgType定义

表8 msgContentType定义

4. 错误码

1.总览

SDK预览流程

(1) SDK预览流程

(2) SDK回放流程

(3) SDK双向语音流程

预览回放相关字段取值表格

表9 eventType事件类型约束表

表10 NVR videoType字段表

表11 IPC videoType字段表

代码示例：

项目合作

在线客服