このページでは、File translation API の使い方について記載します。
目次
- 概要
- 前提条件
- File translation API 利用時の注意点
- File translation API を利用する
- 現在のバージョン
- 認証( Authentication )
- 翻訳対象ページを WOVN に登録する
- 翻訳されたページを WOVN からダウンロードする
- API の検証と開発者向けドキュメント
- サンプル
概要
File translation API は、WOVN がユーザー向けに提供している REST API の一つです。
File translation API とは、WOVN.io が持つ翻訳プラットフォームを利用し、多言語化された HTMLファイルをダウンロードすることができる API です。Upload API と Download HTML API の2つを総称して File translation APIと呼びます。
多言語化された HTMLファイルには、翻訳されたテキストや画像だけでなく、多言語化で必要なサーチエンジン最適化タグ（ SEO対策タグ ）が自動挿入されるので、検索エンジンへ多言語でのインデックスが期待できます。
前提条件
- WOVN.ioプロジェクトが作成されていること
- WOVN.io PRIME プランであること
- WOVNカスタマーサクセス担当により、API機能が有効化されていること
File translation API 利用時の注意点
WOVNサーバーからアクセス可能な場所にWebページを配置する
Upload API および Download HTML API では、WOVNサーバーからユーザー管理の Webサーバーにアクセスします。そのため、IPアドレス制限がかかっていたり、コンテンツがWebサーバーで公開されていなかったりすると、APIを利用して翻訳できません。
元言語でも Download HTML API を実行する
必ず、元言語でも Download HTML APIを実行してください。そして、実行後に取得できる HTMLファイルをオリジナルの HTMLファイルと置き換えてください。
この API を実行することで、SEO対策タグが元言語にも適切に挿入されます。また、WOVN JavaScript が元言語に挿入され、言語切替ウィジェットが元言語でも動作するようになります。
File translation API を利用する
API を利用するには、API機能を有効にし、APIトークンを生成する必要があります。
API機能はWOVNカスタマーサクセス担当にて有効にする必要があります。
API の利用が必要な場合、お問い合わせください。
APIトークンを生成する
API機能が有効になっていると、WOVN管理画面の「設定」に「セキュリティ」メニューが表示されます。
- WOVN管理画面の「設定」→「セキュリティ」→「API 管理」から「APIキーの生成」をクリックしてください。
- 生成された APIキーをコピーし、安全な場所に保管してください。
注意
必ず、安全かつ後から確認できるところに保管してください。
この画面を閉じると、表示された API は二度と画面に表示されません。
WOVNカスタマーサクセス担当でも確認できませんのでご注意ください。
現在のバージョン
現在提供している API のバージョンは v1 です。
このページの説明は v1 に対応しています。
認証( Authentication )
ファイル翻訳API では、 APIキー を用いた jwtAuthentication で認証します。APIキーは WOVN管理画面の「設定」→「セキュリティ」メニューから生成することができます。
jwtAuthentication を利用するには、それぞれのHTTPリクエストヘッダーにパラメーターを設定します。
パラメータ : X-Wovn-Key
設定例
X-Wovn-Key: Token token=YOUR_API_KEY
翻訳対象ページを WOVN に登録する
Upload API は、インターネット上に公開されている Webページの URL を WOVN へ通知し、ページ内コンテンツを WOVN へ取得するための API です。この API を実行することで、Webページコンテンツが WOVN管理画面に表示されます。指定する URL は、WOVNサーバーからアクセスできる必要があります。
詳細なパラメーターについては、 API の検証と開発者向けドキュメント で確認してください。
翻訳されたページを WOVN からダウンロードする
Download HTML API は、元となる URL に対して翻訳したい言語の言語コードを指定することで、指定した言語に翻訳された HTMLファイルをダウンロードすることができる API です。 指定する URL には、WOVNサーバーからアクセス可能な必要があります。
詳細なパラメーターについては、 API の検証と開発者向けドキュメント で確認してください。
API の検証と開発者向けドキュメント
WOVN API ページを参照し、詳細なパラメーターについて確認してください。
サンプル
Upload API を使ってWOVNにページやコンテンツを登録する
```sh
curl -X POST "https://api.wovn.io/v1/upload_page" \
-H "accept: application/json" \
-H "X-Wovn-Key: Token token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d "
{\"url\":\"https://example.com/path/to/your/page.html\",\"project_token\":
\"t0k3n1\"}"
```
多言語対応した HTML を取得する
```sh
curl -X GET "https://api.wovn.io/v1/download_html?url=https%3A%2F%2Fexample.com%2Fpath%2Fto%2Fyour%2Fpage.html&project_token
=t0k3n1&target_lang_code=en&url_pattern=path" \
-H "accept: text/html" \
-H "X-Wovn-Key: Token token=YOUR_API_TOKEN"
```
日本語( ja )の言語コードを( japan )に変更して多言語対応した HTML を取得する
```sh
url -X GET "https://api.wovn.io/v1/download_html?url=https%3A%2F%2Fexample.com%2Fpath%2Fto%2Fyour%2Fpage.html&
project_token=t0k3n1&target_lang_code=ja&
url_pattern=path&custom_lang_aliases_json=%7B%20%20%22ja%22%3A%20%22japan%22%7D"
-H "accept: text/html"
```