一组 API calls 可用,用于:
-
与 Phrase 及任何第三方软件(翻译管理工具、CMS 等)的集成。
-
开发译员工作台。CAT Editor 建立在公共 API 之上。
-
使用 Phrase 作为后端创建全新工具或服务。
基本工作流
在使用 API 之前,必须了解相关流程和工作流。建议在实现相关 API 之前,先熟悉 Phrase 中的某个流程。
基本工作流是:
异步 API
应始终优先选择异步 API,而非同步 API。如果调用同步 API,在处理大批量文件或甚至单个大文件时,有可能收到超时过期的响应。同步 API 只适合用于小文件和小规模集成。
轮询
在调用异步 API 后,立即收到包含标识符请求的响应。使用此标识符,通过调用 getAsyncRequest 来检查请求的状态,并检查 asyncResponse 字段。这种轮询方法可能会导致在收到非空的 asyncResponse 之前,多次调用 getAsyncRequest。
回调
为应对轮询方法在异步请求中的不足,所有异步 API 均支持回调。在调用异步请求时,需要在 callbackUrl 参数中指定一个 URL,该 URL 会在异步请求启动的工作完成后被调用。
回调请求通过 HTTP POST 调用发出,数据以 JSON 编码的形式在请求主体中传递。JSON 对象始终包含:
-
有关异步请求的信息(与调用 getAsyncRequest 时相同)。
-
有关操作结果的详细信息,例如完整的分析或工作详情。
{
"asyncRequest": {
...
}
"analyse": {
...
}
}
如果回调 URL 不可访问,请求将在 2、4、8、16 和 30 分钟后重复,直到 10 次重试失败。
回调 URL 必须以 200 OK HTTP 状态代码响应,才能被视为成功。