このセクションの記事

Translation Sets API v1

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

目次

概要

Translation Sets API を使うと、例えば、ユーザーの特定のアクションに応じて Web バックエンドで動的に翻訳を行い、完了後に翻訳されたバリューを返すことができます。
より柔軟に、ユーザーへ多言語コンテンツを提供することができます。

前提条件

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

API 機能の有効化

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

API 機能は WOVN カスタマーサクセス担当で有効化します。
API の利用が必要な場合は、導入担当へ、あるいは WOVN 管理画面右上の「お問い合わせ」ボタンからお問い合わせください。

API キーの発行

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

  1. 「設定」→「セキュリティ」→「API管理」から、「APIキーを生成する」をクリックします。

    Translation Sets API v2_2.png

  2. 発行された API キーをコピーし、安全な場所に保管してください。

    mceclip5.png

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

現在のバージョン

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

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

インフォメーション
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/v1/translation_sets

各メソッドについて

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

翻訳対象バリューの取り出し（GET/translation_sets）

あらかじめ POST/translation_sets で格納したバリューの翻訳を取り出します。
API によって返されるデータは JSON 形式の文字列です。

翻訳対象バリューの新規格納（POST/translation_sets）

新規バリューを翻訳し、結果を WOVN 上のデータベースに登録します。
登録したバリューは、 GET/translation_sets で取得できます。
また、この API を実行する際に callback_url パラメーターを指定することで、翻訳完了後に指定した URL へ翻訳結果が送信されます。

注意点

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

サンプル

翻訳の格納 POST/translation_sets

 curl --request POST  --url https://api.wovn.io/v1/translation_sets  --header 'authorization: Token token="eyJ......p7lks4Py-WtoRgN1Qhj5cAa8qw"'  --header 'content-type: application/json'  --data '{ "project_token": "t0k3n1", "translation_sets": [ { "id": "japanese_set", "terms": [ { "id": "id001", "src": "おはようございます" }, { "id": "id002", "src": "こんにちはAPI" } ] }] }'

翻訳の取得 GET/translation_sets

 curl -X GET "https://api.wovn.io/v1/translation_sets?project_token=t0k3n1&translation_set_ids[]=japanese_set&term_ids[]=id001&term_ids[]=id002" -H "accept: application/json" -H "Authorization: Token token=YOUR_API_TOKEN"

レスポンスサンプル

 { "project_token": "t0k3n1", "translation_sets": [ { "id": "japanese_set", "terms": [ { "id": "id001", "src": "おはようございます", "status": "translated", "translations": { "en": "Good morning" } }, { "id": "id002", "src": "こんにちは", "status": "translated", "translations": { "en": "Hello" } } ] }