语到开放平台--通用接口

2021-02-21 14:27:55

1.公共请求参数

公共参数是用于标识用户和接口鉴权目的的参数，如非必要，在每个接口单独的接口文档中不再对这些参数进行说明，但每次请求均需要携带这些参数，才能正常发起请求。

字段名	类型	描述	必填	备注
appKey	appKey	appKey	true
timeStamp	Number	13位时间戳	true
sign	String	加密参数	true

2.公共响应参数

具体业务场景的返回参数是由公共响应参数+业务响应数据组成。其data字段为具体响应的数据。

字段名	类型	描述
result	String	状态1: 成功 0:失败
data	Object	业务响应数据
errorCode	String	错误码
errorMsg	String	错误信息
errorDetail	String	错误详细信息

3.签名（sign）算法说明

3.1 计算步骤

1.将公共请求参数+业务请求参数+appSecret以"key=value"形式按照key的ASCII码升序排列并使用"&"连接，得到字符串“X”
2.签名sign等于字符串“X”的MD5加密
3.签名是为了保证调用安全，使用MD5算法生成的一段字符串，生成的签名长度为 32位，签名中的英文字符均为小写格式。
4.发起请求时，只需要发送公共请求参数和业务请求参数即可，appSecret无需携带。

3.2 示例

将“苹果”从使用机器翻译，从中文翻译成英文：

1、通过控制台查看平台分配的
appKey：abc123456
appSecret：sec654321
2、确定其他参数:
content=苹果
srcLanguage=zh
tarLanguage=en
timeStamp=1234567890123
3、将第1、2步骤的参数以"key=value"形式按照key的ASCII码升序排列并使用"&"连接：
X == appKey=abc123456&appSecret=sec654321&content=苹果&srcLanguage=zh&tarLang=en&timeStamp=1234567890123
4、计算sign：
sign= MD5（X） //java.security.MessageDigest.getInstance("md5")
sign=f89f9594663708c1605f3d736d01d2d4
5、最终请求参数
https://tapi.iol8.com/mt/textTranslate/?appKey=abc123456&content=苹果&srcLanguage=zh&tarLang=en&timeStamp=1234567890123&sign=f89f9594663708c1605f3d736d01d2d4

4.文件ID（fileId）获取说明

4.1 API地址

语到提供的大部分接口是需要文件支持，为了增加传输效率，我们提供单独文件上传接口。您可以先将待传输的文件上传，获取fileId，使用此唯一ID进行接口传输。

文件传输 HTTP地址：http://tapi.iol8.com/openapi/file/upload
文件传输 HTTPS地址：https://tapi.iol8.com/openapi/file/upload

4.2 业务请求参数

以下请求参数仅表示上传业务的请求参数，完成请求参数需要增加公共参数，公共参数列表见公共请求参数。

字段名	类型	描述	必填
fileName	String	文件名	true
fileUrl	String	文件路径	true

4.3 业务响应参数

字段名	类型	描述
fileId	String	文件ID

{
"result": "1",
"data": {
"fileId": "60dfd8397d25c37bc3c2e40b960f0b44"
},
"errorCode": null,
"errorMsg": null,
"errorDetail": null
}

5.回调和通知

此部分主要应用于语到主动回调用户的行为，具体参数和定义如下:

字段名	类型	描述	是否非空
action	String	具体回调行为如下： translationCancel:笔译退款 translationReversion:笔译返稿	否
refParams	String	用户自定义参数	否
sign	String	请求签名	是
timeStamp	Number	请求时间戳，13位毫秒数	是

回调地址：
笔译返稿回调地址：{callback}/translationReversion
笔译取消回调地址：{callback}/translationCancel

回调参数：

{
"action":"orderCancel", //行为
"refParams ":"", //客户自定义返回参数
"sign": "ecbb823bdc8f4d7587529a80e4d97e68", //签名
"timeStamp" : 1577808000000,
.... //业务参数
}

响应通知：

{
"result":true,
"errorMsg":"",
"errorCode":""
}

6.错误码列表

错误码	含义
250001	系统错误
250002	参数为空或者格式有误
250003	请求过于频繁
250008	文件不存在
250029	不支持的文件类型
250041	文件上传失败
250042	不支持的文件格式
250045	不支持的语种类型
250053	文字内容超出限制
250054	处理失败
250055	应用不存在
250056	应用被禁用
250057	应用未授权
270001	余额不足

注：想要了解详细情况请访问语到开放平台

人工智能知识库

点击次数