文档简介:
用户内容检测上传
用户内容检测上传订购信息
进入用户信息管理界面后和查看站点主动扫描订购信息,用户内容上传订购信息包含用户ID、已订基础包、基础包到期时间、本月可用总量(条)、本月已审计量(条)和本月未审计量(条)等数据。
服务模式选择
用户内容检测上传提供Agent客户端和API接口调用等两种服务模式。针对没有开发能力的客户可选择Agent客户端模式;针对有开发能力的客户可选择API接口调用模式。用户可根据自身的实际情况选择一种适合的服务模式。
Agent配置及使用
用户如果使用Agent,支持的操作系统有桌面版:Windows 7,Windows 8,Windows 8.1,Windows 10;服务器版:Windows Server 2008 R2,Windows Server 2012,Windows Server 2016,Windows Server 2019。Agent运行需要安装.net 4.8环境,需要能访问公网。
1、进入【帮助文档】菜单里的【Agent下载】菜单,按文档环境要求配置好.net 4.8环境,并下载Agent软件。
2、使用管理员权限运行agent程序目录下的SWAuditAgent.exe,输入用户名,点击“注册”。
3、注册成功后,设置监控目录和结果输出目录,点击更改
4、可在程序log目录查询内容审计日志。
5、在test-result目录查看审计结果
API接口调用(有开发能力客户使用)
一、API接口规范
用户根据以下API接口规范,开发API调用客户端,上传内容信息,接收反馈审计结果。
一、通用输入参数
LoginName 字符串 用户名
RandomNum字符串 随机数(客户端生成)
SignString字符串 签名字符串(客户端生成)
注:所有参数只接受POST方式提交
二、文字提交
a) URL
/api/AuditTxt
b) 输入参数
AuditString字符串 审计文字(不超过1000字节)
c) 输出参数
ErrorCode 整型 错误代码(0:正常;-1:签名验证错误;-2:已超过套餐数目;-3:程序错误)
AuditResult 整型 审计结果(1:正常;0:异常;-1:出错)
Reason 字符型 异常原因(或出错原因,审计结果为正常时此项留空)
三、文本文件提交
a) URL
/api/AuditTxtFile
b) 输入参数
UploadFile 文件型 上传文件(支持rar(不支持rar5),zip,7z三种压缩文件(无密码),以及txt,log.html,htm等格式的文本文件(此格式列表可在服务器端配置),支持gb2312和utf8两种编码格式(自动识别))
c) 输出参数
ErrorCode 整型 错误代码(0:正常;-1:签名验证错误;-2:已超过套餐数目;-3:程序错误)
ReturnList ApiTxtOneFile型列表 审计结果列表
Reason 字符型 出错原因,错误代码为正常时此项留空
ApiTxtOneFile类型说明:
FileName 字符型 上传文件名
AuditResult 整型 审计结果(1:正常;0:异常;-1:出错)
Reason 字符型 异常原因(或出错原因,审计结果为正常时此项留空)
四、图片文件提交
a) URL
/api/AuditImgFile
b) 输入参数
UploadFile 文件型 上传文件(支持rar(不支持rar5),zip,7z三种压缩文件(无密码),以及jpg,jpeg,png,bmp等格式的图片文件(此格式列表可在服务器端配置))
c) 输出参数
ErrorCode 整型 错误代码(0:正常;-1:签名验证错误;-2:已超过套餐数目;-3:程序错误)
ReturnList ApiImgOneFile型列表 审计结果列表
Reason 字符型 出错原因,错误代码为正常时此项留空
ApiImgOneFile类型说明:
FileName 字符型 上传文件名
AuditResult 整型 审计结果(1:正常;0:异常;-1:出错)
Reason 字符型 异常原因(或出错原因,审计结果为正常时此项留空)
五、视频文件提交
a) URL
/api/AuditVdoFile
b) 输入参数
UploadFile 文件型 上传文件(支持rar(不支持rar5),zip,7z三种压缩文件(无密码),以及asf,avi,flv,mkv,mp4,rm,rmvb等格式的视频文件(此格式列表可在服务器端配置))
注:由于视频文件较大,审计时间较长,此处不建议上传压缩文件
c) 输出参数
ErrorCode 整型 错误代码(0:正常;-1:签名验证错误;-2:已超过套餐数目;-3:程序错误)
ReturnList ApiVdoOneFile型列表 审计结果列表
Reason 字符型 出错原因,错误代码为正常时此项留空
ApiVdoOneFile类型说明:
FileName 字符型 上传文件名
AuditResult 整型 审计结果(1:正常;0:异常;-1:出错)
Reason 字符型 异常原因(或出错原因,审计结果为正常时此项留空)
ImgList ApiVdoSnapImg型列表 违规截图列表(审计结果为正常、审计出错时此项留空)
ApiVdoSnapImg类型说明:
TimeValue 字符型 图片时间点(格式HH:mm:ss)
ImageByte 字节列表 图片Byte字节(可由客户端获取后另存为图片)
公钥制作
参考以下示例制作公钥。
1、点击WEB页面上方【帮助文档】菜单,即可显示生成证书、生成签名Php、生成签名Java、生成签名C#和接口格式等信息。
2、点击【生成证书】菜单,可查看生成证书的方法介绍。
3、点击【生成签名Php】菜单,可查看生成签名Php的方法介绍。
4、点击【生成签名Java】菜单,可查看生成签名Java的方法介绍。
5、点击【生成签名C#】菜单,可查看生成签名C#的方法介绍。
公钥上传和查看
1、点击WEB页面上方【上传公钥】菜单,即可显示查看公钥和上传公钥界面。
2、点击【查看公钥】菜单,如果之前上传过公钥即可显示当前的公钥,否则当前公钥为空。
3、点击【上传公钥】菜单,进入上传公钥界面,选择公钥文件,点击导入即可。
系统日志
1、点击WEB页面上方【系统日志】菜单,即可显示当前用户的操作日志信息。
2、在查询条件栏选择开始时间、结束时间和操作类型,点击‘查询’,可查询设置时间段和特定类型的操作日志。
3、在查询结果栏可显示查询的操作日志。