APIテクノロジー（TMS）

私たちのAPIは、アプリケーションエンティティ（プロジェクト、ジョブ、設定）を取得、作成、変更、削除できるリソースとして見なします。 

すべてのHTTPメソッドはアクションを表します：

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

すべての応答リストはページ分けされています。要求されたデータを取得するには、パラメータpageNumberとpageSizeを使用してください。最大ページサイズは50です。

ドキュメント

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": "ADMIN",
                "email": "jan.janocko@phrase.com"
            },
            "client": null,
            "note": "TMで使用する必要はありません、"
            "dateCreated": "2018-01-09T14:07:46+0000",
            "id": "1",
            "targetLangs": [
                "es",
                "it"
            ],
            "subDomain": null,
            "businessUnit": {
                "id": "1",
                "name": "First BU"
            },
            "sourceLang": "en",
            "domain": null,
            "name": "My new TM"
        }
    ],
    "numberOfElements": 1,
    "totalElements": 1,
    "pageSize": 50,
    "totalPages": 1
}

新しい翻訳メモリを作成

POST

/web/api2/v1/transMemories

{{
"name": "My new TM",
"sourceLang": "en",
"targetLangs": [
"es", "it-IT"
],
"businessUnit": {
"id": "1"
},
"note": "TMで使用する必要はありません"
}

レスポンス

201

{
    "internalId": 1,
    "createdBy": {
        "userName": "admin",
        "id": "3",
        "firstName": "J",
        "lastName": "Jan",
        "role": "ADMIN",
        "email": "jan.j@phrase.com"
    },
    "client": null,
    "note": "TMで使用する必要はありません、"
    "dateCreated": "2018-01-09T14:07:46+0000",
    "id": "1",
    "targetLangs": [
        "es",
        "it"
    ],
    "subDomain": null,
    "businessUnit": {
        "id": "1",
        "name": "First BU"
    },
    "sourceLang": "en",
    "domain": null,
    "name": "My new TM"
}

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

このファイルをリクエストの本文にバイナリ添付ファイルとして追加します。PhraseとContent-Dispositionヘッダーが正しく挿入されていることを確認してください。

PostmanからのサンプルPHP：

<?php

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

$request->setQueryData(array(
'token' => 'あなたのトークンをここに入れてください'
));

$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();
} catch (HttpException $ex) {
echo $ex;
}

エラーハンドリング

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

{ "errorCode": "InvalidArguments",
"errorDescription": "Required argument \"password\" of type \"string\" is missing."
}

エラー応答は、HTTPステータスレスポンスのコードを読み取ることで検出できます。エラーが発生した場合、2xxには決して設定されません。ステータスコードは400不正リクエスト、401または403は認証または承認の問題です。

問題の報告

テクニカルサポートに問題を報告する際は、報告に次の内容を含めてください：