コンテンツにスキップ

認証とAPIキー

APIセンター でsk_ APIキーを作成します。完全なキーは、作成時またはローテーション時に一度だけ表示されます。

各アプリケーション、環境、および自動化タスクごとに独立したキーを使用し、それぞれが独自の権限設定を持ち、個別に無効化、ローテーション、監査できるようにします。

推奨:

X-API-Key: sk_your_key

標準の Bearer フォームも機能します:

Authorization: Bearer sk_your_key

リクエストでは、両方のうちいずれか一方のみを送信してください。

Terminal window
curl https://omnidoc.top/api/v1/jobs \
-H "X-API-Key: $OMNIDOC_API_KEY"

キーは作成したアカウントに対してのみ機能します。そのアカウントが利用可能なサービスを呼び出し、そのアカウントのリソースにのみアクセスできます。キーは、サインインに使用されるメールアドレス、パスワード、電話番号、またはプロフィールを変更することはできません。また、APIキーを作成、ローテーション、または失効させることもできません。

オプションの制限値:

  • allowed_engines:リストされた翻訳設定のみが対象であり、空の配列はキー レベルでの制限を追加しません。
  • expires_at:有効期限。
  • quota_limit:鍵のライフタイム予算はミリクレジット単位で指定されます。0では鍵レベルの予算は設定されず、アカウントのクレジットは通常通り決済されます。

APIセンターでキーを作成し、その制限を変更したり、ローテーションしたり、無効化したりできます。キーが無効化、停止、または期限切れになった場合、あるいは対応するアカウントが無効化された場合、新しいリクエストは直ちに失敗します。

ローテーションにより新しいシークレットが生成され、同時に古いシークレットが無効化されます。新しいキーは元の制限事項および既に使用済みの予算を引き継ぎます。期限切れのキーはローテーションできないため、新たに作成してください。スムーズな切り替えを行うには、まず新しいキーを作成してデプロイし、呼び出しが成功することを確認した後、古いキーを失効させてください。

  • キーはサーバー上または制御された実行環境にのみ保持してください。
  • 環境変数またはシークレットマネージャーを使用し、キーをソースコード、ログ、ブラウザバンドル、または公開リポジトリに決して格納しないでください。
  • API が返すアップロードまたはダウンロード用のアドレスには、決してキーを送信しないでください。
  • キーID、リクエストID、および操作IDを記録し、完全なキーは決して記録しないでください。
  • キーが漏洩した場合は、直ちにローテーションし、そのキーに関連するジョブと課金を確認してください。