API

サーバーからJSONやファイルを翻訳し、進捗を確認して、翻訳済みのファイルをダウンロードできます。

Lingo.devのAPIを使って、アプリケーションが管理するコンテンツを翻訳できます。ローカライズジョブは、エンジン、ソース言語、ターゲット言語、1つ以上のドキュメントで構成されます。各ドキュメントでは、リクエストした言語ごとに翻訳先のターゲットを追跡します。ほとんどの形式ではターゲットごとに個別のファイルが生成されますが、アップルの文字列カタログでは複数の言語が1つのファイルにまとめられます。

APIのベースURLはhttps://api.lingo.dev/v2です。APIの認証情報はサーバー上で保管してください。まずは初めての翻訳リクエストに沿って、2つのメッセージを翻訳し、結果を保存してみましょう。

入力を選ぶ #

コンテンツ始め方
アプリケーションがすでに保持しているJSONオブジェクトJSONを翻訳。作成リクエストでオブジェクトを直接送信します。
JSON、マークダウン、HTML、モバイル向けリソースなどのファイルドキュメントを翻訳。元のバイトデータをアップロードし、同じ形式のファイルをダウンロードします。
複数のドキュメントやターゲット言語翻訳ジョブを作成。1つのジョブにインラインJSONとアップロードしたファイルの両方を含められます。

3つとも、処理の流れは共通です。

  1. ジョブを作成し、そのIDをソースのリビジョンとともに保存します。
  2. レスポンスのuploads配列に記載されたすべての成果物をアップロードします。インラインJSONのソースは、ジョブの作成時に保存されます。
  3. ジョブを開始します。
  4. 必要なドキュメントの各ターゲットの処理が完了するまで、進捗を確認します。
  5. 完了した各ターゲットを、それぞれのstatus.downloadUrlからダウンロードします。

ジョブの作成時には、実行する作業が保存されます。ジョブを開始すると、その作業が受け付けられ、処理が始まります。作成リクエストが成功しても、そのレスポンスは翻訳結果ではありません。

再利用できる内容や概算費用を確認したい場合は、ジョブを作成する前に作業量を見積もってください。

翻訳を設定する #

engineIdでエンジンを明示的に選択します。エンジンは、モデル、用語集、ルール、ブランドボイスに加え、翻訳パイプラインを提供します。APIキーには、そのエンジンを使って翻訳するためのアクセス権が必要です。

JSONの場合は、format.optionsを使ってドキュメント固有のコンテキスト、ヒント、保護対象のパスを追加します。その後のリビジョンでは、以前のソースと翻訳を指定することで、変更のないコンテンツを再利用できます。

人によるレビューでは、権限を持つレビュアーが、パイプラインの次の処理に進む前に、対象の翻訳を承認または編集できます。送信、レビュー、配信を連携させる方法は、レビューワークフローガイドで説明しています。

ジョブとともにアプリケーションの状態を保持する #

次に進む前に、ジョブID、ソースのリビジョン、ドキュメントキー、リクエストしたロケールを永続的に保存してください。ジョブの作成時にIdempotency-Keyヘッダーを使うと、レスポンスの成否が不明な場合でも、別のジョブを作成せずに再試行できます。代わりのジョブを送信する前に、既存の作業を取得してください。

ほかのターゲットの処理が失敗しても、完了したターゲットはダウンロードしてください。結果を公開するのは、その結果がアプリケーションの想定するソースのリビジョンに引き続き対応している場合に限ります。この連携方法は、翻訳ワークフローの構築で説明しています。

アクセスと復旧については、認証、エラー、エラーカタログを参照してください。

エンジンを準備・改善する #

プロビジョニングでは、ウェブサイトのコンテンツやテキストをもとに、用語集、ルール、ブランドボイスを設定します。エンジンの提案では、フィードバックをもとに、内容を確認して適用できる提案を作成します。生成された指針は、翻訳に使う前にレビューしてください。