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