设备端API

说明

1. 以下API使用前，请阅读快速上手
2. 入参为无时传{}
3. 出参为无时，只返回code

获取服务器时间

• 接口：server/getServerTime
• header中需token: 否
• 入参：无
• 出参：

名称	字段	类型	可选	说明
服务端时间	serverTime	string	N

登录前检查

• 接口：v1/terminal-active/check-login
• header中需token: 否
• 入参：

名称	字段	类型	可选	说明
授权码	cdkey	string	N
设备UId	deviceUId	string	N	设备端生成的唯一识别号

• 出参：无
• 异常编码：515 （授权码被其它设备登录）

授权码登录

• 接口：v1/terminal-active/login
• header中需token: 否
• 入参：

名称	字段	类型	可选	说明
授权码	cdkey	string	N
设备UId	deviceUId	string	N	设备端生成的唯一识别号
设备长边	posX	number	N
设备短边	posY	number	N
请求tag	tag	string	N	和获取token时使用的是同一个

• 出参：

名称	字段	类型	可选	说明
token	token	string	N	用于有需要用token的接口
设备号	terminalCode	string	N
商户号	sellerId	number	N
网点号	pointNo	string	N
设备id	terminalId	number	N
网点id	pointId	number	N
授权码	activateSn	string	N
屏幕方向	screenPoint	number	N

扫码登录-获取登录信息

• 接口：v1/terminal-active/get-token-by-deviceUId
• header中需token: 是
• 入参：

名称	字段	类型	可选	说明
请求tag	tag	string	N	和登录时入参的tag使用的是同一个

• 出参：

名称	字段	类型	可选	说明
token	token	string	N	用于有需要用token的接口
设备号	terminalCode	string	N
商户号	sellerId	number	N
网点号	pointNo	string	N
设备id	terminalId	number	N
网点id	pointId	number	N
授权码	activateSn	string	N
屏幕方向	screenPoint	number	N

签到

• 接口：v1/terminal-active/sign
• header中需token: 是
• 入参：无
• 出参：无

上传设备信息

• 接口：v1/terminal-active/upload-terminal-info
• header中需token: 是
• 入参：

名称	字段	类型	可选	说明
api根地址	api	string	N
二维码根地址	ewm	string	N
设备ID	terminalId	string	N	商户平台创建设备自动生成
设备编号	terminalNo	string	N	商户平台创建设备输入的设备编号
网点号	pointNo	string	N
网点ID	pointId	string	N
商户号	merchantId	string	N
日志类型	logType	string	N
屏幕长边	posX	string	N	无论横竖屏，取的都是长边
屏幕短边	posY	string	N
总容量	storeCapacity	string	N
剩余容量	freeCapacity	string	N
总内存	totalRam	string	N
剩余内存	availRam	string	N
剩余SD卡容量	availSDCard	string	N
SD卡容量	totalSDCard	string	N
应用使用容量	appUsedSpace	string	N
mac	mac	string	N
IP地址	ip	string	N
操作系统名称	os	string	N
操作系统版本	osVersion	string	N
APP版本	appVersion	string	N
webview内核	browserKernel	string	N
图片质量模式	imgMode	string	N
视频质量模式	videoMode	string	N
webview的userAgent	userAgent	string	N
主应用环境	h5ENV	string	N
主应用版本	h5Version	string	N
主应用版本	h5version	string	N
屏幕大小	size	string	N
屏幕方向	orientation	string	N
屏幕旋转角度	angle	string	N
排期ID	channelId	string	N
排期名称	channelName	string	N
节目ID	programId	string	N
节目名称	programName	string	N
设备的安卓id	deviceId	string	N
设备的序列号	serialNum	string	N
设备制造商	manufacturer	string	N
设备的型号	model	string	N
设备的品牌	brand	string	N
设备的名称	device	string	N
设备的信息	deviceInfo	string	N
生成的设备唯一标识	deviceUId	string	N
渠道号	flavor	string	N
渠道号	channel	string	N
时区	timeZone	string	N

• 出参：无

同步设备信息

• 接口：v1/terminal-active/get-terminal-info
• header中需token: 是
• 入参：

名称	字段	类型	可选	说明
	logType	string	N	名字参考上面接口
	posX	string	N
	posY	string	N
	freeCapacity	string	N
	availRam	string	N
	availSDCard	string	N
	appUsedSpace	string	N
	mac	string	N
	ip	string	N
	osVersion	string	N
	appVersion	string	N
	browserKernel	string	N
	imgMode	string	N
	videoMode	string	N
	userAgent	string	N
	h5ENV	string	N
	h5Version	string	N
	h5version	string	N
	size	string	N
	orientation	string	N
	angle	string	N
	channelId	string	N
	channelName	string	N
	programId	string	N
	programName	string	N
	timeZone	string	N

• 出参：无

同步播放数据

• 接口：v1/terminal-active/dispatch-info
• header中需token: 是
• 入参：

名称	字段	类型	可选	说明
排期ID集合	existChannelId	Array	N

• 出参： 无

日志上传

• 接口：terminalManage/v2/sys-log-upload
• header中需token: 是
• 入参：

名称	字段	类型	可选	说明
设备号	code	string	N
商户号	sellerId	string	N
日志数据	data	JSON Array	N	参考如下日志数据data

日志数据 data

名称	字段	类型	可选	说明
模块	module	string	N
	operator	string	N
	traceId	string	N
	deviceNo	string	N
	ip	string	N
渠道	channel	string	N	app端固定为2，android
跟踪号	sellerId	string	N
日志类型	type	string	N	app端全是事件，默认为3
事件编码	event	string	N
业务编码	bizCodeType	string	N
日志等级	level	string	N
日志数据	data	string	N
	occurTime	date	N	YYYY-MM-DD HH:mm:ss
	activeTime	date	N	YYYY-MM-DD HH:mm:ss

• 出参：无

回执服务器

• 接口：channelPublish/target/v2/resultNotify
• header中需token: 是
• 入参：

名称	字段	类型	可选	说明
回执数据	data	JSON Array	N	参考如下回执数据data

回执数据 data

名称	字段	类型	可选	说明
下发的notifyId	id	number	N	下发编号
编号	code	number	N	默认值0
回执类型	type	number	N	1:收到下发的回执 2:收到下发且处理完成的回执
下发的UUID	uuid	string	Y	当下发数据中存在uuid时
回执数据	data	string	Y

• 出参：无

获取日志上报间隔时长

• 接口：BizConfig/search
• header中需token: 是
• 入参：

名称	字段	类型	可选	说明
请求参数	terms	Array	N	默认值：[{"code": "code","type": "text","value": "appRecordTimerTask"}]

• 出参：

名称	字段	类型	可选	说明
内容	content	Array	N	取第一项的value

MODE自动获取

• 接口：mode/v2/select/all
• header中需token: 是
• 入参：

名称	字段	类型	可选	说明
能确定唯一设备的编码	code	string	Y

• 出参：

名称	字段	类型	可选	说明
浏览器	BROWSER	number	N	UNKNOWN = -1;//未知 //浏览器 BROWSER_SYS = 0; BROWSER_QQ = 1;
图片	IMAGE	number	N	UNKNOWN = -1;//未知 //图片 IMAGE_LOAD_STANDARD = 0;//图片加载 标准 IMAGE_LOAD_QUALITY = 1;//图片加载 质量
视频	VIDEO	number	N	UNKNOWN = -1;//未知 //视频 VIDEO_EXOPLAYER_SURFACE_LOOP = 0; VIDEO_EXOPLAYER_TEXTURE_LOOP = 1; VIDEO_EXOPLAYER_SURFACE = 2; VIDEO_EXOPLAYER_TEXTURE = 3;

MODE选择

• 接口：mode/v2/select/all
• header中需token: 是
• 入参：

名称	字段	类型	可选	说明
类型	type	string	N	VIDEO,//视频 BROWSER,//浏览器 IMAGE//图片
能确定唯一设备的编码	code	string	Y

• 出参：

名称	字段	类型	可选	说明
模式	mode	int	N

APP智能升级版本

• 接口：upgrade/version
• header中需token: 否
• 入参：

名称	字段	类型	可选	说明
app版本	version	string	N
商户id	sellerId	long	Y
市场code	marketCode	string	Y
应用名称	appName	string	Y

• 出参：

名称	字段	类型	可选	说明
最新版本	latestVersion	string	Y
是否强制升级	url	string	Y
是否强制升级	isForce	boolean	Y
是否需要升级	isNeedUpgrade	boolean	Y