Phrase TMS API

APIテクノロジー(TMS)

本コンテンツはPhrase Language AIの機械翻訳により、英語から翻訳されています。

APIはアプリケーション実体(プロジェクト、ジョブ、設定)を、取得、作成日、更新済、削除が可能なリソースとして認識します。 

各 HTTP メソッドはアクションを表します。

  • GET

    リソースを取得して変更しない

  • POST

    リソースを作成。ポストは、4つの操作のいずれにも当てはまらない操作や、入力が長く複雑な操作(翻訳メモリの検索やジョブの作成など)にも使用されます。

  • PUT

    リソースを更新します。変更されたフィールドだけでなく、エンティティ全体がそのすべてのフィールドと共に必要であることにご備考ください。含まれていないということはnull送信先設定する必要があるということです。

  • 削除

    リソースを削除します。

インポート

入出力データは通常、UTF-8 でエンコードされた JSON フォームです。ファイルが要求本文のコンテンツ タイプとしてアプリケーション/オクテットストリームまたはマルチパート/フォームデータが使用されている場合。

良好な応答時間を維持する送信先に、エンティティは可能な限りフラットな構造を使用します。回答に子オブジェクト全体を含める代わりに、ID、UID、およびその他のいくつかのタグ属性を含む参考資料が含まれます。送信先の関連エンティティを参照する IDReference または UidReference オブジェクトが必要です。

すべての応答一覧がページ送りされます。リクエストされたデータの取得にはパラメーター pageNumberpageSize 送信先を使用します。最大ページサイズは50です。

Documentation

OpenAPI 3.0 は API ドキュメントに使用されます。クライアント開発には、Swagger コード生成機能が推奨されます。

未編集ドキュメントファイル:

API 例

すべての翻訳メモリの一覧を取得

GET

/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,
            "備考": "TMで使用送信先必要はありません",
            "dateCreated":"2018-01-09T14:07:46+0000",
            "id":"1",
            "targetLangs": [
                "es",
                "it"
            ],
            "subDomain": null,
            "businessUnit": {
                "id":"1",
                "name":「最初のBU」
            },
            "sourceLang": "en",
            "domain": null,
            "name":「私の新規TM」
        }
    ],
    "numberOfElements":1,
    "totalElements":1,
    "pageSize":50,
    "totalPages":1
}

翻訳メモリの新規作成

POST

/web/api2/v1/transMemories

{{
"name":"新規 TM",
"sourceLang": "en",
"targetLangs": [
"es","it-IT"
],
"businessUnit": {
"id":"1"
},
"備考": "TMで送信先使用は必要ありません"
}

返答

201

{
    "internalId":1,
    "createdBy": {
        "userName": "admin",
        "id":"3",
        "firstName":"J",
        "lastName":Jan",
        "role":「管理者」、
        "email": "jan.j@phrase.com"
    },
    "client": null,
    "備考": "TMで使用送信先必要はありません",
    "dateCreated":"2018-01-09T14:07:46+0000",
    "id":"1",
    "targetLangs": [
        "es",
        "it"
    ],
    "subDomain": null,
    "businessUnit": {
        "id":"1",
        "name":「最初のBU」
    },
    "sourceLang": "en",
    "domain": null,
    "name":「私の新規TM」
}

ジョブ作成時のファイル追加

このファイルをバイナリ添付としてリクエストの本文送信先追加します。Phrase および コンテンツ破棄 ヘッダーが正しく挿入されていることを確認します。

ポストのサンプルPHP:

<?php

$request = new HttpRequest();
$request->setUrl('https://cloud.phrase.com/web/API2/v1/projects/%7BUID%20of%20your%20project%7D/ジョブ);
$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-サービス.com/consumeCallback\\",\\"importSettings\\":{\\"uid\\":\\"WF0T1SfSHxII09yKr0dZh9\\"}'
));

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

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

エラー処理

API リクエストの処理中に問題が発生した場合は、次の JSON 構造が戻ります。エラーコード は常に表示されます。詳細な説明はnullの場合があります。

{ "errorCode":"InvalidArguments",
"errorDescription":「文字列」タイプの必須引数「パスワード」が欠落しています。
}

エラー応答は、 ステータス API エラー コード(TMS)の読み取りによって検出できます。エラーが発生した場合は、2xx 送信先に設定されません。ステータスコードは400 bad request、認証または認可の問題の場合は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.