订单创建 - zimuFy接口文档

DeepL翻译接口支持原始字幕为单语/双语类型的字幕，可提供字幕文件链接或字幕文本进行处理。使用接口前需要到zimuFy创建api key方可使用。
api订单跟普通订单一样，需要消耗字符量，处理后，也可通过站内的订单记录进行查询与下载。
下面是几个复杂字段的备注说明，点击展开可以查看详情。

排版模式-原字幕是单语类型（mode1）

值	代表的排版模式
1	目标语言1
2	源语言+目标语言1
3	目标语言1+源语言
4	目标语言1+目标语言2
5	目标语言2+目标语言1

排版模式-原字幕是双语类型（mode2）

值	代表的排版模式
3	源语言1+目标语言1
4	目标语言1+源语言1
5	源语言2+目标语言1
6	目标语言1+源语言2
7	目标语言1+目标语言2
8	目标语言2+目标语言1
9	目标语言1

源语言（origin_lang1、origin_lang2）

简体中文, 繁体中文, 英语, 日语, 韩语, 俄语, 德语, 法语, 葡萄牙语, 西班牙语, 保加利亚语, 捷克语, 丹麦语, 希腊语, 爱沙尼亚语, 芬兰语, 匈牙利语, 印尼语, 意大利语, 立陶宛语, 拉脱维亚语, 挪威语, 荷兰语, 波兰语, 罗马尼亚语, 斯洛伐克语, 斯洛文尼亚语, 瑞典语, 土耳其语, 乌克兰语, 阿拉伯语

目标语言（target_lang1、target_lang2）

简体中文, 繁体中文, 英式英语, 美式英语, 日语, 韩语, 俄语, 德语, 法语, 葡萄牙语-巴西, 葡萄牙语-除巴西外, 西班牙语, 保加利亚语, 捷克语, 丹麦语, 希腊语, 爱沙尼亚语, 芬兰语, 匈牙利语, 印尼语, 意大利语, 立陶宛语, 拉脱维亚语, 挪威语, 荷兰语, 波兰语, 罗马尼亚语, 斯洛伐克语, 斯洛文尼亚语, 瑞典语, 土耳其语, 乌克兰语, 阿拉伯语

异步通知

DeepL订单一般耗时3-30秒，具体取决于字幕内容大小。一般创建订单后，可以通过查询接口（/query）轮询结果。也可以在创建订单时设置异步通知链接（notify_url），这样订单后，系统会主动通知订单结果信息到设定的链接。通知结果信息字段如下：

订单处理成功：

字段名	类型	示例
code	integer	1
msg	string	订单处理成功
status	integer	1
file_url	string	https://www.zimufy.com/translate_api/file_down?order_id=zm78377fe0f025t
file_size	string	84 KB
cost_time	integer	251

订单处理失败：

字段名	类型	示例
code	integer	1
msg	string	订单处理失败
status	integer	4

系统以json头部与json内容形式发送POST通知，下面是主流语言接收通知的代码示例，确保最后返回HTTP200状态码即可，如果遇到网络异常或者返回状态码不是200，系统会再重试2次进行通知。

python接收示例

php接收示例

JavaScript接收示例

from flask import Flask, request, jsonify

app = Flask(__name__)

@app.route('/notify', methods=['POST'])
def handle_notify():
  data = request.json  # 自动解析JSON数据
  print("收到通知数据:", data)
  
  # 这里处理业务逻辑，比如验证数据、更新订单状态等
  
  # 返回成功响应 (HTTP 200)
  return 'success'

if __name__ == '__main__':
  app.run(port=5000)

API接口公测上线中，欢迎反馈问题与建议，客服QQ：2801088826 （返回zimuFy官网）

请求参数

Header 参数

Authorization

string

api key的值

必需

示例值:

Bearer 43c1b2de-23e8-4772-875b-4ca9e5cbda68

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

api

enum<string>

翻译接口

必需

deepl接口值为：deepl

枚举值:

aideepl

示例值:

deepl

file_type

enum<string>

文件类型

必需

url-文件链接 text-文件内容

枚举值:

urltext

示例值:

url

file

enum<string>

文件链接或内容

必需

该参数的值为文件链接或文件内容，具体看file_type的值

枚举值:

urltext

示例值:

https://www.zimufy.com/temp/test.srt

file_format

enum<string>

文件格式

必需

支持srt ass vtt

枚举值:

srtassvtt

示例值:

srt

mode1

enum<integer>

排版模式

可选

原字幕为单语时，请使用mode1参数提交排版模式

枚举值:

12345

示例值:

mode2

enum<integer>

排版模式

可选

原字幕为双语时，请使用mode2参数提交排版模式

枚举值:

3456789

示例值:

target_lang1

string

目标语言1

必需

示例值:

简体中文

target_lang2

string

目标语言2

可选

排版模式为7或8时，需要填写

示例值:

日语

origin_lang1

string

源语言1

可选

为空或不填将自动识别

示例值:

英语

origin_lang2

string

源语言2

可选

为空或不填将自动识别

formality

enum<string>

语气偏好

可选

可不填，支持该参数的目标语言：德语、法语、意大利语、西班牙语、荷兰语、波兰语、葡萄牙语、日语、俄语

枚举值:

012

默认值:

示例值:

merge_line

enum<integer>

可选

是否先合并同轴下的多行为一行后，再进行翻译

枚举值:

默认值:

示例值:

keep_style

enum<integer>

可选

是否保留内嵌样式（仅对srt/vtt生效），ass会强制保留样式

枚举值:

默认值:

示例值:

filter_annotation

enum<integer>

可选

是否过滤被（）()[]标记的注释内

枚举值:

默认值:

示例值:

notify_url

string

异步通知链接

可选

可不填，填写的话，订单处理结果会通知到该链接

示例

文件链接请求文件内容请求原字幕是双语类型的请求

{
  "api": "deepl",
  "file_type": "url",
  "file": "https://www.zimufy.com/test.srt",
  "file_format": "srt",
  "mode1": 3,
  "target_lang1": "简体中文"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

enum<integer>

校验码

必需

0-参数校验失败 1-参数校验成功

枚举值:

msg

string

提示信息

必需

order_id

string

订单号

可选

15位由小写字母数字组成

status

enum<integer>

订单状态

可选

0-进行中 1-已完成 4-失败

枚举值:

014

file_tokens

integer

文件字符

可选

cost_tokens

integer

消耗字符

可选

示例

订单创建成功订单创建失败参数校验失败

{
  "code": 1,
  "msg": "订单创建成功",
  "order_id": "zm78354fe0f03ac",
  "status": 0,
  "file_tokens": 5625,
  "cost_tokens": 2574
}