開発者として登録してAPIキーを取得する
文書翻訳用のRESTful APIを提供し、自動翻訳タスク管理、用語集ベースの専門用語統一、対応形式・言語・モデルの照会機能をサポートすることで、シームレスな翻訳ワークフローの構築とユーザーアカウント管理を実現します。
はじめに
開始するには、開発者になるための申請が必要です。開発者として申し込む
承認されると、複数のAPIキーを作成し、必要に応じて各APIリクエストに適切なAPIキーを含めることができます。
クイックアクセス
ベースURL
https://shangyiai.com/api
認証方式
Authorization: [yourSecretKey]
JSONリクエスト
ファイルアップロードAPI以外、APIはデフォルトでPOST JSONリクエストを使用し、Content-Typeはapplication/jsonです。
ファイルアップロード
ドキュメント翻訳タスクの作成はmultipart/form-dataを使用し、fileフィールドに翻訳するファイルを渡します。
汎用エラーレスポンス
リクエストが失敗した際、APIはJSONを返し、errorフィールドには固定の英語エラー情報が含まれます。HTTPステータスコードによるエラー処理を優先し、errorフィールドは表示またはログ記録に使用することを推奨します。
{
"error": "Invalid API key."
}エラーステータスコードルール
すべてのv1 APIエラーレスポンスは同じ構造を保ちますので、以下のHTTP status codeルールに従って処理してください。
- 400 Bad Request
- 必須パラメータの欠落、パラメータ形式または列挙値の無効、ファイルアップロードの欠落、アップロード保存の失敗、またはタスク処理の失敗。
- 401 Unauthorized
- APIキーがないか、無効なAPIキーです。
- 402 Payment Required
- クレジット残高が不足しているため、プレビュー、完全翻訳、またはテキスト翻訳を実行できません。
- 404 Not Found
- タスクまたは用語集が存在しない、削除された、現在のAPIアカウントに属していない、またはAPI経由で作成されていません。
- 409 Conflict
- 現在のタスクステータスでは、要求された操作は許可されていません。
- 500 Internal Server Error
- 予期しないサーバー例外です。応答エラーは「内部サーバーエラー」として固定されています。
推奨導入フロー
1. タスクの作成
ファイルをアップロードして翻訳タスクを作成し、taskIdを返します。
2. 進捗の照会
タスクステータスをポーリングして、Completed、Terminated、またはCancelledになるまで継続します。
3. 結果の取得
訳文ファイルをダウンロード、または原文と訳文のJSONを読み取ります。
4. タスクの管理
従量課金で全文翻訳、タスクの再起動、テキストの修正、またはタスクの削除を行えます。