一组 API 调用可用于:
-
Phrase 和任何第三方软件(翻译管理工具、内容管理系统等)的集成
-
开发译员工作台。CAT 编辑器建立在公共 API 之上。
-
后端使用 Phrase 创建全新的工具或服务。
基本工作流
在使用 API 之前,必须了解程序和工作流程。建议在实施相关 API 之前先熟悉 Phrase 中的某个过程。
基本工作流程是:
异步 API
异步 API 应始终优先于同步 API。如果调用同步 API,在处理大批量文件甚至单个大文件时,可能会收到超时的过期响应。同步 API 应仅用于小文件和小规模集成。
投票
调用异步 API 后,会收到包括标识符请求的即时响应。通过调用 getAsyncRequest 并检查 asyncResponse 字段,使用此标识符检查请求的状态。这种轮询方法可能会导致在收到非 null 的 asyncResponse 之前调用 getAsyncRequest 的次数。
回调
针对异步请求的轮询方法的缺点,支持所有异步 API 中的回调。调用异步请求时,请指定在异步请求启动的工作完成后请求的 URL(在 callbackUrl 参数中)。
通过 HTTP POST 调用请求回调,并在编码为 JSON 的正文中传递数据。JSON 对象始终包含:
-
有关异步请求的信息(与调用 getAsyncRequest 时相同)。
-
有关操作结果的详细信息,如全面分析或工作详细信息。
{ "asyncRequest": { ... } “分析”:{ ... } }
如果无法访问回调 URL,则在 2、4、8、16 和 30 分钟后重复请求,直到 10 次重试失败。
回调 URL 必须以 200 OK HTTP 状态码响应才能视为成功。