Translation Sets API v2

WOVN が提供しているREST API「Translation Sets API v2」の使い方について記載します。

概要

Translation Sets API を使うと、例えば、ユーザーの特定のアクションに応じて Web バックエンドで動的に翻訳を行い、完了後に翻訳されたバリューを返すことができます。

より柔軟に、ユーザーへ多言語コンテンツを提供することができます。

前提条件

WOVN プロジェクトが作成されていること
WOVN.io PRIME プランであること
WOVN カスタマーサクセス担当により、API 機能が有効化されていること

API 機能の有効化

API を利用するには、API機能を有効化し、API キーを発行する必要があります。

API 機能は WOVN カスタマーサクセス担当で有効化します。
API の利用が必要な場合、お問い合わせください。

API キーの発行

API 機能が有効な場合、管理画面の「設定」→「セキュリティ」メニューが表示されます。

「設定」→「セキュリティ」→「API管理」から、「APIキーを生成する」をクリックします。
発行された API キーをコピーし、安全な場所に保管してください。

注意
必ず、安全かつ後から確認できる所に保管してください。
この画面を閉じると、表示された API キーは二度と画面に表示されません。
弊社担当でも確認できませんのでご注意ください。

現在のバージョン

現在提供している API のバージョンは v1 と v2です。
このページでは、v2 について記載しています。

v1 については、Translation Sets API v1 を参照してください。

インフォメーション
Translation sets API v1 と v2 の機能・仕様の違いについては、WOVN API ページを参照してください。

認証（Authentication）

権限を持ったユーザーのみ API が利用できるように、API キーを発行しています。

API を利用するには、全てのエンドポイントにおいて、各 API のヘッダーに下記のような Authorization ヘッダーを付与してください。{API KEY} 部分を発行した API キーに置き換えます（カッコ { } は不要）。

curl -H "Authorization: Token token={API KEY}" https://api.wovn.io/v2/translation_sets

各メソッドについて

各メソッドのパラメーターの詳細については、WOVN API ページ（開発者向けドキュメント）を参照してください。

Translation sets を作成する（TranslationSets - POST）

/v2/translation_sets に対して POST メソッドでリクエストを送信し、Translation sets を作成します。

既存の Translation set ID のリストを取得する（TranslationSets - GET）

/v2/translation_sets に対して GET メソッドでリクエストを送信し、作成済みの Translation sets を取得します。

指定された Translation set に新しい Term を登録する（Terms - POST）

/v2/translation_sets/{translation_set_id}/terms に対して POST メソッドでリクエストし、 Terms を追加します。

Term と翻訳を取得する（Terms - GET）

/v2/translation_sets/{translation_set_id}/terms に対して GET メソッドでリクエストし、 Terms と自動翻訳結果を取得します。取得するには、 translation_set_id と term_id を組み合わせて呼び出します。

term_id は複数指定が可能で、1度のリクエストで、 1つの translation_set から複数のtermを取得することが可能です。また、 term_id を指定しない場合は、 translation_set 内の term すべてを取得します。

この API を実行する際に callback_url パラメーターを指定することで、翻訳完了後に指定した URL へ翻訳結果が送信されます。

注意点

Translation Sets API の POST メソッドで登録した文章のみ、GET で取得可能です。
WOVN.io の他の導入方法により WEB スクレイピングされた文章は、当 API では取得できません。
翻訳修正の際は、ライブ編集は使用できません。管理画面上で編集してください。
リクエスト上限は 17 アクセス/秒です。

サンプル

TranslationSets

POST - Translation sets を作成する

```json

curl -X POST "https://api.wovn.io/v2/translation_sets" \
-H "accept: application/json" \
-H "X-Wovn-Key: Token token=eyJhbGciOiJIUzI1NiJ...省略" \
-H "Content-Type: application/json" \
-d "{ \"translation_sets\":\n
[\n
\"example_set_001\",\n
\"example_set_002\"\n
]\n
}"

```

GET - 作成済みの Translation set ID を取得する

```sh

curl -X GET "https://api.wovn.io/v2/translation_sets" \

-H "accept: application/json" \

-H "X-Wovn-Key: Token token=eyJhbGciOiJIUzI1NiJ...省略" \

```

レスポンスサンプル

```json

{

"data": {

"translation_sets": [

"example_set_001",

"example_set_002",

]

}

```

Terms

POST - 特定の Translation set に Terms を追加する

```json

curl -X POST "https://api.wovn.io/v2/translation_sets/example_set_001/terms" \

-H "accept: application/json" \

-H "X-Wovn-Key: Token token=eyJhbGciOiJIUzI1NiJ...省略" \

-H "Content-Type: application/json"\

-d "{ \"terms\":\n

　　[\n

　　{\n

　　　　\"id\": \"v2_term_001\",\n

　　　　\"src\": \"API v2での新しい翻訳です！\"\n

　　},\n

　　{\n

　　　　\"id\": \"v2_term_002\",\n

　　　　\"src\": \"API v2での新しい翻訳です。しかも、人力翻訳した状態で登録します！\",\n

　　　　\"translations\" :\n

　　　　[\n

　　　　　　{\n

　　　　　　　　\"language\": \"en\",\n

　　　　　　　　\"dst\": \"a new translation value from API v2. Additionally, this value is translated manually!!\"\n

　　　　　　}\n

　　　　]\n

　　}\n

　　]\n

```

GET - Terms と翻訳を取得する

```sh

curl -X GET "https://api.wovn.io/v2/translation_sets/example_set_001/terms" \

-H "accept: application/json" \

-H "X-Wovn-Key: Token token=eyJhbGciOiJIUzI1NiJ...省略" \

```

レスポンスサンプル

```json

{

"data": {

"project_token": "t0k3n1",

"id": "example_set_001",

"terms": [

{

"id": "v2_term_001",

"src": "API v2での新しい翻訳です！",

"translations": [

{

"language": "en",

"dst": "New translation in API v2!"

}

]

{

"id": "v2_term_002",

"src": "API v2での新しい翻訳です。しかも、人力翻訳した状態で登録します！",

"translations": [

{

"language": "en",

"dst": "a new translation value from API v2. Additionally, this value is translated manually!!"

}

]

}

]

}

```

このセクションの記事

目次

概要

前提条件