ヘルプセンターを見る

API経由でMarkdownドキュメントをローカライズする

管理担当:Vitalii Vlasiuk共同創業者

Markdownは、ほとんどのドキュメント、ヘルプ記事、CMSコンテンツですでに採用されている形式です。APIにそのまま送信して対象言語でワークフローを実行すれば、構造を維持した同じMarkdownを言語ごとに取得できます。

目次

Markdownを送信するには?

content_type: "markdown"と翻訳先の言語を指定してPOST /documentsを実行します。Transeptがドキュメントをブロックに分割し、翻訳先ごとに言語バージョンを1件作成します。

その後の見積もりと実行の手順は、APIでTranseptを自動化すると同じです。1回の呼び出しですべての言語バージョンに実行が展開されます。APIの利用にはキーが必要で、StarterプランおよびProプランに含まれています。

# BASE="https://app.transept.ai/api/public/v1"; KEY from Settings → Developer
curl -s -X POST $BASE/documents \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{"title": "Getting started", "content_type": "markdown", "source_language": "en",
       "target_languages": ["de", "fr"],
       "content": "# Getting started\n\nInstall the app, then…"}'
# → { document_id, language_group: [ {id, target_language}, … ] }

訳文を取得するには?

言語バージョンごとにGET /documents/{id}/content?format=markdownを実行すると、構造を維持したレンダリング済みMarkdownが返されます。その他の形式(ブロックごとに読み取るjson、docx、pdf、xliff、csv)は、APIでTranseptを自動化するの形式一覧表に記載されています。

curl -s "$BASE/documents/<de-version-id>/content?format=markdown" \
  -H "Authorization: Bearer $KEY"

変更された箇所だけを再翻訳するには?

後から原文が変更された場合は、再インポートする代わりに再同期します。POST /documents/{id}/resync-sourceを実行すると、変更のないブロック(およびその訳文)は維持され、変更または追加されたブロックのみに未更新マークが付きます。変更分のみを対象とする実行では、それらのブロックだけが処理されます。これはAPI経由で文字列カタログをローカライズするのキー単位の差分更新に相当する機能です。全般的な動作については、変更された箇所だけを実行するをご確認ください。

# the source changed? re-align, then run only what went stale
curl -s -X POST $BASE/documents/<master>/resync-source \
  -H "Authorization: Bearer $KEY"
よくある質問✦

ドキュメントの構造は翻訳後も維持されますか?

はい。見出し、リスト、リンク、強調、インラインコードは翻訳しても崩れず、エクスポートでも再現されます。そのため、訳したファイルも原文と同じパイプラインにそのまま組み込めます。

変更のないドキュメントを再実行すると、もう一度料金がかかりますか?

いいえ、かかりません。変更分のみを対象とする動作では、前回の実行以降に原文が変更されたブロックだけが処理されます。変更のないドキュメントは再実行しても料金がかからず、小さな修正なら数ブロック分で済みます。

解決しない場合は、アプリ内のLiteressに質問するか、[email protected]までご連絡ください。