上传

接口名称：uploadTranslate

接口完整路径：http://dev.open.fanyigou.net/TranslateApi/api/uploadTranslate

接口说明：用户调用接口进行 源文件上传，上传完成后会自动进行翻译，通过tid可以查询翻译的进度等数据。注意：

1.上传格式：pdf、doc、docx、ppt、pptx、xls、xlsx、png、jpg、jpeg、bmp

2.上传文件最大50M

3. 不支持扫描件、图纸、纯图片文档，加密文件请先去除密码

4.翻译完成后按1分/页从主账号里扣费

5.目前仅支持一条翻译通道（即只能同时进行一个文件的上传翻译）

6.图片格式（png、jpg、jpeg、bmp）源语言仅支持部分语言，详见语言列表

调用说明：请求方式：post, file参数请以 multipart/form-data 方式的表单 POST 提交

入参列表：

出参列表：

data结果集：

返回结果:

{"code": 100,"data": {"tid": 14587},"msg": "请求成功"}

下载

接口名称：downloadFile

接口完整路径：http://dev.open.fanyigou.net/TranslateApi/api/downloadFile

接口说明：根据tid获取翻译后的文件，然后下载（可下载原文件（不扣分）及翻译后的文件（pdf-需扣除 2积分/页、word-需扣除 5积分/页)，均按照原文件页数扣分）

入参列表：

出参列表：

说明：1.判断Response Headers 中 detectLanguage 的值，若存在且不为空即为自动检测出的语言（可能为多种语言），仅供参考

2.判断Response Headers 中 Content-Type 的值，若包含"application/octet-stream" 则可直接进行下载，否则即为以下返回值

返回结果:

{"code": 312,"msg": "该翻译不存在"}

翻译记录

接口名称：queryTransList

接口完整路径：http://dev.open.fanyigou.net/TranslateApi/api/queryTransList

接口说明：用户通过appid查询翻译过的记录。

入参列表：

出参列表：

data结果集：

返回结果:

{
	"code": 100,
	"data": {
		"total":20,
		"tlist":[
		{
		"createTime": "2018-03-27 16:57:51",
		"docType": "docx",
		"fromLan": "",
		"msg": "正在翻译",
		"pageCount": 1,
		"percent": "99.00",
		"status": 313,
		"tid": 14587,
		"title": "测试",
		"toLan": "中文",
		"updateTime": "2018-03-27 16:58:00"
		},
		{
		"createTime": "2018-03-27 16:57:51",
		"docType": "docx",
		"fromLan": "",
		"msg": "正在翻译",
		"pageCount": 1,
		"percent": "99.00",
		"status": 313,
		"tid": 14588,
		"title": "测试",
		"toLan": "中文",
		"updateTime": "2018-03-27 16:58:00"
		}
	  	]
	},
	"msg": "请求成功"
}
                

获取任务进度

接口名称：queryTransProgress

接口完整路径：http://dev.open.fanyigou.net/TranslateApi/api/queryTransProgress

接口说明：提交翻译完成后可调用此接口实时查询任务进度（建议调用间隔在2s及以上）

入参列表：

出参列表：

data结果集：

返回结果:

{
	"code": 100,
	"data": {
		"createTime": "2018-03-27 16:57:51",
		"docType": "docx",
		"fromLan": "",
		"msg": "进行中",
		"pageCount": 1,
		"percent": "99.00",
		"status": 313,
		"tid": 14587,
		"title": "测试",
		"toLan": "中文",
		"updateTime": "2018-03-27 16:58:00"
	},
	"msg": "请求成功"
}

                

积分使用列表

接口名称：getScoreList

接口完整路径：http://dev.open.fanyigou.net//TranslateApi/api/getScoreList

接口说明：用户根据自己的appid查询积分使用状况

入参列表：

出参列表：

data结果集：

返回结果:

                {
                   "code": 100,
		  "data": {
		     "total": 1,
		    "tlist": [
		      {
		        "createtime": "2017-11-08 15:53:29",
		        "info": "下载文档扣除积分",
		        "score": 100,
		        "type": "1",
		       }
		    ],
		   },
		   "msg": "请求成功"

                }
                

获取账户信息

接口名称：getAccount

接口完整路径：http://dev.open.fanyigou.net//TranslateApi/api/getAccount

接口说明：获取账户信息

入参列表：

出参列表：

data结果集：

返回结果:

{"code":100,"data":{"deductType":1,"balance":137684},"msg":"请求成功"}

文档转换

接口名称：convert

接口完整路径：http://dev.open.fanyigou.net/TranslateApi/api/convert

接口说明：用户调用接口进行 源文件上传，上传完成后会自动进行转换，通过tid可以查询转换的进度等数据。注意：

1.上传格式：pdf、doc、docx、ppt、pptx、xls、xlsx、hwp、caj

2.上传文件最大50M

3.加密文件请先去除密码

4.转换完成后按页从主账号里扣费

5.目前仅支持一条翻译通道（即只能同时进行一个文件的上传文档转换）

调用说明：请求方式：post, file参数请以 multipart/form-data 方式的表单 POST 提交

入参列表：

出参列表：

data结果集：

返回结果:

{"code": 100,"data": {"tid": 14587},"msg": "请求成功"}

回调通知

回调说明：翻译任务、转换任务，失败或成功时会发起回调

目前回调地址需要后台设置，后续会开放设置

请求方式：post, application/json

回调接口处理完成后须返回“success”字符串

回调参数列表：

回调JSON示例:

{"createTime":"2021-08-25 14:27:47","detectLan":"","docType":"pdf","fromLan":"中文","msg":"完成","pageCount":1,"percent":"100.00","status":314,"tid":19432525,"title":"test","toLan":"英语","updateTime":"2021-08-25 14:27:47"}

安全规范

1、签名算法

签名生成的通用步骤如下：

第一步，设所有发送或者接收到的数据为集合M(包括平台生成的privatekey)，将集合M内非空参数值的参数按照参数名ASCII码从小到大排序（字典序），使用URL键值对的格式（即key1=value1&key2=value2…）拼接成字符串stringA。

特别注意以下重要规则：

◆ 参数名ASCII码从小到大排序（字典序）；
◆ 如果参数的值为空不参与签名；
◆ 参数名区分大小写；
◆ 验证调用返回或主动通知签名时，传送的token参数不参与签名，将生成的签名与该token值作校验。
◆ 接口可能增加字段，验证签名时必须支持增加的扩展字段

第二步，对stringA进行MD5运算，再将得到的字符串所有字符转换为大写，得到token值。
◆ privatekey设置路径：翻译狗开发平台(域名XX)-->控制台-->开发者信息-->申请信息

举例：

假设传送的参数如下：

appid：1522125815142
tid：14526
nonce_str：ibuaiVcKdpRxkhJA
from : en
to : zh
md5 : 5b21f2eeda4726c74274fc27a53bac74

第一步：对参数按照key=value的格式(包括privatekey)，并按照参数名ASCII字典序排序如下：
                    
stringA="appid=1522125815142&from=en&md5=5b21f2eeda4726c74274fc27a53bac74&nonce_str=ibuaiVcKdpRxkhJA&privatekey=4892ef64ewf5sffdf&tid=14526&to=zh";



第二步：加密：

token=MD5(stringA).toUpperCase()="7D5FA1767E5848472081B448554B39EB" 

最终得到最终发送的数据：
appid：1522125815142
tid：14526
nonce_str：ibuaiVcKdpRxkhJA
from : en
to : zh
md5 : 5b21f2eeda4726c74274fc27a53bac74
token : 7D5FA1767E5848472081B448554B39EB
                

2、生成随机数算法

API接口协议中包含字段nonce_str，主要保证签名不可预测。我们推荐生成随机数算法如下：调用随机数函数生成，将得到的值转换为字符串。

协议规则

语言列表

状态码列表

行业列表