API接口规范
文本字符串提交
a) URL
http://API公网IP/api/AuditTxt
b) 提交方式
POST
c)输入参数
参数名 | 参数类型 | 参数说明 |
---|---|---|
LoginName | 字符串 | 用户名 |
RandomNum | 字符串 | 随机数(客户端生成) |
SignString | 字符串 | 签名字符串(客户端生成,将LoginName+","+RandomNum由私钥加密之后传输) |
AuditString | 字符串 | 要审计的文字 |
UsePY | 布尔型 | 是否使用同音识别(true:是;false:否),不传值时默认为false |
Jump | 布尔型 | 是否使用跳符号识别(true:是;false:否),不传值时默认为false |
Minute | 布尔型 | 是否开启分词(true:是;false:否),不传值时默认为false |
输出参数
参数名 | 参数类型 | 参数说明 |
---|---|---|
ErrorCode | 整型 | 错误代码(0:正常;-1:签名验证错误;-2:已超过套餐数目;-3:程序错误) |
AuditResult | 整型 | 审计结果(1:正常;0:异常;-1:出错) |
Reason | 字符型 | 低俗,制假售假,政治,暴恐,涉政,涉黄,票据,色情,赌博,违法违规,违禁品,邪教,政治,返回以上分类格式为:色情,命中关键字:一夜情,18禁 |
NeedReview | 整型 | 是否需要人工审核(0:否,1:是) |
RemainNum | 整型 | 剩余可审计数量 |
Participle | 字符型 | 分词结果 |
HitType | 字符型 | 命中描述 |
文本文件提交
URL
http://API 公网 IP/api/AuditTxtFile
提交方式
a)POST
b)输入参数
参数名 | 参数类型 | 参数说明 |
---|---|---|
LoginName | 字符串 | 用户名 |
RandomNum | 字符串 | 随机数(客户端生成) |
SignString | 字符串 | 签名字符串(客户端生成,将LoginName+","+RandomNum由私钥加密之后传输) |
UploadFile | 文件型 | 上传文件(支持 rar (不支持rar5) ,zip两种压缩文件(无密码),以及txt,log,html,htm等格式的文本文件,支持gb2312和utf8两种编码格式(自动识别)) |
UsePY | 布尔型 | 是否使用同音识别(true:是;false:否),不传值时默认为false |
Jump | 布尔型 | 是否使用跳符号识别(true:是;false:否),不传值时默认为false |
Minute | 布尔型 | 是否开启分词(true:是;false:否),不传值时默认为false |
c)输出参数
参数名 | 参数类型 | 参数说明 |
---|---|---|
ErrorCode | 整型 | 错误代码(0:正常;-1:签名验证错误;-2:已超过套餐数目;-3:程序错误) |
ReturnList | ApiTxtOneFile型列表 | 审计结果列表 |
Reason | 字符型 | 出错原因,错误代码为正常时此项留空 |
AuditResult | 整型 | 审计结果(1:正常;0:异常;-1:出错) (选用ReturnList里面的AuditResult) |
RemainNum | RemainNum | 剩余可审计数量 |
d)ApiTxtOneFile 类型说明:
参数名 | 参数类型 | 参数说明 |
---|---|---|
FileName | 字符型 | 上传文件名 |
AuditResult | 整型 | 审计结果(1:正常;0:异常;-1:出错) |
Reason | 字符型 | 低俗,制假售假,政治,暴恐,涉政,涉黄,票据,色情,赌博,违法违规,违禁品,邪教,政治 返回以上分类 |
NeedReview | 整型 | 是否需要人工审核(0:否,1:是) |
RemainNum | 整型 | 剩余可审计数量 |
Participle | 字符型 | 分词结果 |
HitType | 字符型 | 命中描述 |
e) 示例
输入参数:
LoginName | testuser |
---|---|
RandomNum | 577983 |
SignString | m13owlqq/bEGbrQonSBgxRi2MhNo/aEXWfbW4ofwuNksMRT 5ep2xm0JPSWsLA1vCk3rBW82sZAjrS08UaUnxYx3RjJebBY XQvnePso2E6R5EkYVgI9JDdhGTW7eT2rcLWUOKFOEH6Ny4s ZV7+rB1ba2x+kjJ+awz5lZ07dvKz3c= |
UploadFile | 上传的文件 |
返回 JSON
程序运行正常:
{"ErrorCode":0,"ReturnList":[{"FileName":"KeyWord.txt","AuditResult":1,"Reason":"normal","NeedReview":1,"KeywordType","",,"Contents","",,"HitType","",,"FileTxt","",,"Participle",""},{"FileName":"addurl1.txt","AuditResult":0,"Reason":"ad","NeedReview":1,"KeywordType","",,"Contents","",,"HitType","",,"FileTxt","",,"Participle",""},{"FileName":"addurl2.txt","AuditResult":0,"Reason"
:"contraband","NeedReview":1,"KeywordType","",,"Contents","",,"HitType","",,"FileTxt","",,"Participle",""}],"Reason":""}
程序运行异常:
{"ErrorCode":-1,"ReturnList":[],"Reason":"签名验证错误"}
图片文件提交
a)URL
综合识别(色情+对象+样例+人脸),速度慢:
http://API 公网 IP/api/AuditImgFile
色情识别:
http://API 公网 IP/api/AuditSexFile
对象识别:
http://API 公网 IP/api/AuditTerrorFile
样例识别:
http://API 公网 IP/api/AuditSampleFile
人脸识别:
http://API 公网 IP/api/AuditFaceFile
b) 提交方式
POST
输入参数
参数名 | 参数类型 | 参数说明 |
---|---|---|
LoginName | 字符串 | 用户名 |
RandomNum | 字符串 | 随机数(客户端生成) |
SignString | 字符串 | 签名字符串(客户端生成) |
UploadFile | 文件型 | 上传文件(支持rar (不支持rar5) ,zip两种压缩文件(无密码),以及 jpg,jpeg,png,bmp等格式的图片文件 |
输出参数
参数名 | 参数类型 | 参数说明 |
---|---|---|
ErrorCode | 整型 | 错误代码(0:正常;-1:签名验证错误;-2:已超过套餐数目;-3:程序错误) |
ReturnList | ApiImgOneFile型列表 | 审计结果列表 |
Reason | 字符型 | 出错原因,错误代码为正常时此项留空 |
RemainNum | 整型 | 剩余可审计数量 |
AuditResult | 整型 | 审计结果(1:正常;0:异常;-1:出错) (选用 ReturnList里面的AuditResult) |
ApiImgOneFile 类型说明:
参数名 | 参数类型 | 参数说明 |
---|---|---|
FileName | 字符型 | 上传文件名 |
AuditResult | 整型 | 审计结果(1:正常;0:异常;-1:出错) |
Reason | 字符型 | 返回描述如色情,性感,命中人脸,命中样例等。还有文件不存在,文件解压失败,签名错误等错误描述 |
Score | 整型 | 疑似分数(0-100) |
NeedReview | 整型 | 是否需要人工审核(0:否,1:是) |
File | 字符型 | 上传文件完整地址 |
OcrResult | 字符型 | OCR识别结果 |
KeywordType | 字符型 | 关键字类别(OCR适用) |
ImageByte | byte[] | 图片byte字节 |
示例
输入参数:
LoginName | testuser |
---|
RandomNum | 282426 |
---|---|
SignString | jBDMzG4wGLaXPMcqyTj5VS4ab2DjnuneGwl /IV863/ujIKQTFP2Nh2tzI7GBlYdh5Oszaw TOX6rzNiuVkg2uJRw4s+JSegXDJFDl933Ew PYK0UHekvG88hkax34n/0BFtwO3SLj7AXiEB /z/7k/pQtlkhp2EHTJbQhzqwtmvZRc= |
UploadFile | 上传的文件 |
返回 JSON
程序运行正常:
{"ErrorCode":0,"ReturnList":[{"FileName":"8ebfe122gy1fmo7mbmjovj20j60asq4n.jpg","AuditResult":0,"Reason":"normal","Score":90,"NeedReview":0},{"FileName":"abd2b4119313b07ec7119c1707d7912397dd8c25.jpg","AuditResult":0,"Reason":"porn","Score":70,"NeedReview":1},{"FileName":"dabe950a304e251f832b2d98ae86c9177e3e5378.jpg","AuditResult":0,"Reason":" 色 情","Score":93,"NeedReview":0}],"Reason":""}
程序运行异常:
{"ErrorCode":-1,"ReturnList":[],"Reason":"签名验证错误"}
OCR图片文件提交
URL
http://API 公网 IP/api/AuditOcrFile
提交方式
POST
输入参数
参数名 | 参数类型 | 参数说明 |
---|---|---|
LoginName | 字符串 | 用户名 |
RandomNum | 字符串 | 随机数(客户端生成) |
SignString | 字符串 | 签名字符串(客户端生成) |
UploadFile | 文件型 | 上传文件(支持rar (不支持rar5) ,zip两种压缩文件(无密码),以及jpg,jpeg,png,bmp等 格式的图片文件 |
UsePY | 布尔型 | 是否使用同音识别(true:是;false:否),不传值时默认为false |
d) 输出参数
参数名 | 参数类型 | 参数说明 |
---|---|---|
ErrorCode | 整型 | 错误代码(0:正常;-1:签名验证错误;-2:已超过套餐数目;-3:程序错误) |
ReturnList | ApiImgOneFile型列表 | 审计结果列表 |
Reason | 字符型 | 出错原因以及命中原因如:命中关键字:xxx,xxx,错误代码为正常时此项留空 |
RemainNum | 整型 | 剩余可审计数量 |
AuditResult | 整型 | 审计结果(1:正常;0:异常;-1:出错) (选用 ReturnList 里面的 AuditResult) |
ApiImgOneFile 类型说明:
参数名 | 参数类型 | 参数说明 |
---|---|---|
FileName | 字符型 | 上传文件名 |
AuditResult | 整型 | 审计结果(1:正常;0:异常;-1:出错) |
Reason | 字符型 | 分类(normal正常,sexy性感图片,porn色情图片) |
Score | 整型 | 疑似分数(0-100) |
NeedReview | 整型 | 是否需要人工审核(0:否,1:是) |
File | 字符型 | 上传文件完整地址 |
OcrResult | 字符型 | OCR识别结果 |
KeywordType | 字符型 | 关键字类别(OCR适用) |
ImageByte | byte[] | 图片byte字节 |
e) 示例
输入参数:
LoginName | testuser |
---|---|
RandomNum | 282426 |
SignString | jBDMzG4wGLaXPMcqyTj5VS4ab2DjnuneGwl /IV863/ujIKQTFP2Nh2tzI7GBlYdh5Oszaw TOX6rzNiuVkg2uJRw4s+JSegXDJFDl933Ew PYK0UHekvG88hkax34n/0BFtwO3SLj7AXiEB /z/7k/pQtlkhp2EHTJbQhzqwtmvZRc= |
UploadFile | 上传的文件 |
返回 JSON
程序运行正常:
{"ErrorCode":0,"ReturnList":[{"FileName":"8ebfe122gy1fmo7mbmjovj20j60asq4n.jpg","AuditResult":0,"Reason":"命中关键字:关键字 1,关键字 2","OcrResult":"这是 OCR的识别结果", " KeywordType":"政治","NeedReview":0},"Reason":""}
程序运行异常:
{"ErrorCode":-1,"ReturnList":[],"Reason":"签名验证错误"}
视频文件提交
a)URL
http://API 公网 IP/api/AuditVdoFileMore
b) 提交方式 POST
c) 输入参数
参数名 | 参数类型 | 参数说明 |
---|---|---|
LoginName | 字符串 | 用户名 |
RandomNum | 字符串 | 随机数(客户端生成) |
SignString | 字符串 | 签名字符串(客户端生成) |
UploadFile | 文件型 | 上传文件(支持rar (不支持rar5) ,zip,7z三种压缩文件(无密码), 以及asf,avi,flv,mkv,mp4,rm,rmvb等格式的视频文件(此格式列表可在服务器端配置)) |
id | 整型 | id识别类型:1智能识别,2人脸识别,3样例识别,0综合识别 |
输出参数
参数名 | 参数类型 | 参数说明 |
---|---|---|
ErrorCode | 整型 | 错误代码(0:正常;-1:签名验证错误;-2:已超过套餐数目;-3:程序错误) |
ReturnList | ApiVdoOneFile型列表 | 审计结果列表 |
Reason | 字符型 | 出错原因,错误代码为正常时此项留空 |
AuditResult | 整型 | 审计结果(1:正常;0:异常;-1:出错)选用ReturnList中的AuditResult |
RemainNum | 整型 | 剩余可审计数量 |
ApiVdoOneFile 类型说明:
参数名 | 参数类型 | 参数说明 |
---|---|---|
FileName | 字符型 | 上传文件名 |
AuditResult | 整型 | 审计结果(1:正常;0:异常;-1:出错) |
Reason | 字符型 | 异常原因 |
ImgList | ApiVdoSnapImg型列表 | 违规截图列表 |
ImgNameList | List<(string,string)> | 违规截图列表 |
ApiVdoSnapImg 类型说明:
参数名 | 参数类型 | 参数说明 |
---|---|---|
TimeValue | 字符型 | 图片时间点(格式HH:mm:ss) |
ImageByte | 字节列表 | 图片Byte字节(可由客户端获取后另存为图片) |
输入参数:
LoginName | testuser |
---|
RandomNum | 282426 |
---|---|
SignString | jBDMzG4wGLaXPMcqyTj5VS4ab2DjnuneGwl /IV863/ujIKQTFP2Nh2tzI7GBlYdh5Oszaw TOX6rzNiuVkg2uJRw4s+JSegXDJFDl933Ew PYK0UHekvG88hkax34n/0BFtwO3SLj7AXiEB /z/7k/pQtlkhp2EHTJbQhzqwtmvZRc= |
UploadFile | 上传的文件 |
Id | 0 |
返回 JSON
程序运行正常:
{"ErrorCode":0,"ReturnList":[{"FileName":"123.avi","AuditResult":0,"Reason":"normal","Score":90,"NeedReview":0,"ImgList":["00:01:00":,"ImageByte":"xxx"]
}],"Reason":""}
程序运行异常:
{"ErrorCode":-1,"ReturnList":[],"Reason":"签名验证错误"}
视频文件提交(抽帧)
a)URL
http://API 公网 IP/api/GetPicsFromVdoFile
b) 提交方式 POST
c) 输入参数
参数名 | 参数类型 | 参数说明 |
---|---|---|
LoginName | 字符串 | 用户名 |
RandomNum | 字符串 | 随机数(客户端生成) |
SignString | 字符串 | 签名字符串(客户端生成) |
UploadFile | 文件型 | 上传文件(支持rar (不支持rar5) ,zip,7z三种压缩文件(无密码 ) ,以及asf,avi,flv,mkv,mp4,rm,rmvb等格式的视频文件(此格式列表可在服务器端配置)) |
输出参数
参数名 | 参数类型 | 参数说明 |
---|---|---|
ErrorCode | 整型 | 错误代码(0:正常;-1:签名验证错误;-2:已超过套餐数目;-3:程序错误) |
ReturnList | ApiVdoOneFile型列表 | 审计结果列表 |
Reason | 字符型 | 出错原因,错误代码为正常时此项留空 |
AuditResult | 整型 | 审计结果(1:正常;0:异常;-1:出错)选用ReturnList中的AuditResult |
RemainNum | 整型 | 剩余可审计数量 |
---|
ApiVdoOneFile 类型说明:
参数名 | 参数类型 | 参数说明 |
---|---|---|
FileName | 字符型 | 上传文件名 |
AuditResult | 整型 | 审计结果(1:正常;0:异常;-1:出错) |
Reason | 字符型 | 异常原因 |
ImgList | ApiVdoSnapImg型列表 | 违规截图列表 |
ImgNameList | List<(string,string)> | 违规截图列表 |
ApiVdoSnapImg 类型说明:
参数名 | 参数类型 | 参数说明 |
---|---|---|
TimeValue | 字符型 | 图片时间点(格式HH:mm:ss) |
ImageByte | 字节列表 | 图片Byte字节(可由客户端获取后另存为图片) |
输入参数:
LoginName | testuser |
---|---|
RandomNum | 282426 |
SignString | jBDMzG4wGLaXPMcqyTj5VS4ab2DjnuneGwl /IV863/ujIKQTFP2Nh2tzI7GBlYdh5Oszaw TOX6rzNiuVkg2uJRw4s+JSegXDJFDl933Ew PYK0UHekvG88hkax34n/0BFtwO3SLj7AXiEB /z/7k/pQtlkhp2EHTJbQhzqwtmvZRc= |
UploadFile | 上传的文件 |
返回 JSON
程序运行正常:
{"ErrorCode":0,"ReturnList":[{"FileName":"123.avi","AuditResult":0,"Reason":"normal","Score":90,"NeedReview":0,"ImgList":["00:01:00":,"ImageByte":"xxx"]
}],"Reason":""}
程序运行异常:
{"ErrorCode":-1,"ReturnList":[],"Reason":"签名验证错误"}
4、点击【生成签名Php】菜单,可查看生成签名Php的方法介绍。
5.点击【生成签名C#】菜单,可查看生成签名C#的方法介绍。
6.点击【生成签名JAVA】菜单,可查看生成签名JAVA的方法介绍。