Phrase TMS API

API 技术 (TMS)

文本由 Phrase Language AI 从英语机器翻译而得。

我们的 API 将应用程序实体(项目、工作、设置)视为可以检索、创建、修改和删除的资源。 

每个 HTTP 方法都代表一个操作:

  • 获取

    检索资源,永不更改资源

  • 请求

    创建一个资源。请求 还使用于搜索翻译记忆库或创建工作等不属于这四种操作或输入很长或很复杂的操作。

  • PUT

    更新资源。请注释,需要'整个实体'',其所有字段而不仅仅是已更改的字段;不包括它意味着它应设置至 null。

  • 删除

    删除资源。

导入

输入和输出数据通常采用JSON表格,UTF-8编码。对于请求正文内容类型的文件,使用了应用程序/八位字节流或多部分/表格数据。

实体尽可能使用扁平结构至保持良好的响应时间。答案中不包含整个子对象,而是包含 id、Uid 和其他一些属性的参考。期望IDReferenceUidReference对象提及至相关实体。

所有响应列表都被分页。使用参数pageNumberpageSize检索请求的数据。页面大小上限为 50。

文档

OpenAPI 3.0 使用于 API 文档。建议客户开发Swagger代码生成器

原始文档文件:

API 示例

获取所有翻译记忆库的列表

获取

/web/api2/v1/transMemories

回复

200

{
    "pageNumber":0,
    "content": [
        {
            "internalId":1,
            "createdBy": {
                "userName": "admin",
                "id":"3",
                "firstName":"Jan",
                "lastName":"Janocko",
                "role":“管理员”,
                "email": "jan.janocko@phrase.com"
            },
            "client": null,
            “注释”:“不必至翻译记忆库使用”,
            "dateCreated":"2018-01-09T14:07:46+0000",
            "id":"1",
            "targetLangs": [
                "es",
                "it"
            ],
            "subDomain": null,
            "businessUnit": {
                "id":"1",
                "name":“第一个BU”
            },
            "sourceLang": "en",
            "domain": null,
            "name":“我的新建 翻译记忆库”
        }
    ],
    "numberOfElements":1,
    "totalElements":1,
    "pageSize":50,
    "totalPages":1
}

新建翻译记忆库

请求

/web/api2/v1/transMemories

{{
"name":“我的新建翻译记忆库”,
"sourceLang": "en",
"targetLangs": [
“es”,“it-IT”
],
"businessUnit": {
"id":"1"
},
“注释”:“不必至翻译记忆库使用”
}

回复

201

{
    "internalId":1,
    "createdBy": {
        "userName": "admin",
        "id":"3",
        "firstName":"J",
        "lastName":"Jan",
        "role":“管理员”,
        "email": "jan.j@phrase.com"
    },
    "client": null,
    “注释”:“不必至翻译记忆库使用”,
    "dateCreated":"2018-01-09T14:07:46+0000",
    "id":"1",
    "targetLangs": [
        "es",
        "it"
    ],
    "subDomain": null,
    "businessUnit": {
        "id":"1",
        "name":“第一个BU”
    },
    "sourceLang": "en",
    "domain": null,
    "name":“我的新建 翻译记忆库”
}

创建工作时添加文件

将此文件作为二进制附件添加至请求正文。确保 Phrase"" 和 内容-Disposition="" 标头已正确插入。

请求的 PHP 示例:

<?php

$request = new HttpRequest();
$request->setUrl('https://cloud.phrase.com/web/API2/v1/projects/%7BUID%20of%20your%20project%20D/工作);
$request->setMethod(HTTP_METH_POST);

$request->setQueryData(array(
令牌 => 令牌转到此处
));

$request->setHeaders(array(
'postman-token' => 'ABC',
'cache-control' => 'no-cache',
'content-disposition' => 'filename*=UTF-8''Sample.txt',
'memsource' => '{\\"targetLangs\\]:[\\"de\\",\\"fr\\",\\"es\\"],\\"callbackUrl\\]:\\"https://my-shiny-service.com/consumeCallback\\",\\"importSettings\\]:{\\"uid\\]:\\"WF0T1SfSHxII09yKr0dZh9\\"}}'
));

try {
$response = $request->send ( ) ;

echo $response->getBody();
} CAT (HttpException $ex) {
echo $ex;
}

错误正在处理

如果正在处理 API 请求时出现问题,将返回以下 JSON 结构。将始终显示 '错误代码';详细描述可能为空。

{ "errorCode":"InvalidArguments",
"errorDescription":“字符串”类型的必需参数“密码”丢失。”
}

可通过读取响应的 HTTP 状态 代码来检测错误响应。如果发生错误,永远不会设置为2xx。状态是 400 错误请求,401 或 403 表示身份身份验证或授权问题。

报告问题

将问题报告至技术支持时,在报告中包括以下内容:

  • API 端点

  • 请求

  • 时间(和时区)

  • 回复

  • 响应的 Phrase-Action-id

这篇文章有帮助吗?

Sorry about that! In what way was it not helpful?

The article didn’t address my problem.
I couldn’t understand the article.
The feature doesn’t do what I need.
Other reason.

Note that feedback is provided anonymously so we aren't able to reply to questions.
If you'd like to ask a question, submit a request to our Support team.
Thank you for your feedback.