Managing DeepL API keys
A guide covering multiple API keys for Pro API and Free API users
Last updated
A guide covering multiple API keys for Pro API and Free API users
Last updated
DeepL API ProおよびDeepL API Freeユーザー向け、複数のAPIキーについてのガイド
本記事では、DeepL APIの新機能である複数のAPIキーについて説明します。この新機能はDeepL Free ProおよびDeepL API Freeにご登録のお客様にご利用いただけます。
この機能に関するご意見やご感想は、DeepL APIチーム api-feedback@deepl.com までお寄せください。
本記事は他の言語でもご覧いただけます。ページ上部のドロップダウンメニューからご希望の言語をお選びください。
APIプランでは、1つのアカウントで複数の有効なAPIキーを同時に作成できるようになりました。本記事では、APIキーを管理する方法について説明します。
複数のAPIキーの使用は、ユーザーから最もリクエストの多かった機能の1つです。今までは1つのアカウントにつき作成できる有効なAPIキーは1個のみで、新しいAPIキーを作成すると既存のAPIキーは無効になっていました。
複数のAPIキーのユースケースとして、以下のようなものが挙げられます。
· 用途ごと(開発、テスト、プロダクションなど)または DeepL APIを使用するチームごとに一意のキーを作成することで、たとえキーが無効になって新しいキーを作成する必要がある場合でも、他の環境やチームに影響を及ぼしません。
· プロダクション時に新しいキーを作成し、新しいキーが稼動してから古いキーを無効化することで、ダウンタイムなしで新しいAPIキーをローテーションできます。
APIキーの確認および管理は、DeepL APIのアカウントにログインした後「APIキー」タブから行えます。
新しいAPIキーを作成
新しいAPIキーを作成します。APIキーの作成時には、オプションで任意の名前を付けることができます。キーに名前を付けない場合「DeepL APIキー」という名前が自動的に付けられます。
名前を付けると「APIキー」タブの検索バーを使ってAPIキーの名前で検索できます。
APIキーを作成すると、新しく作成したキーについてポップアップが表示されます。ポップアップ上ではキーをコピーでき、すぐに使用できます。また「APIキー」タブの表からいつでもキーをコピーできます。
DeepL API Freeにご登録のお客様は、同時に2個まで有効なAPIキーを作成できます。
DeepL API Proにご登録のお客様は、同時に25個まで有効なAPIキーを作成できます。
APIキーの無効化
有効なAPIキーを無効化します。注意:APIキーは無効化すると直ちに機能しなくなります。APIキーを無効化すると、再度有効化することはできないためご注意ください。
今までのAPIキーのユーザーインターフェース(下図)では、「新しい認証キーを作成する」ボタンをクリックすると現在のキーが無効化され、同時に新しいキーが作成されていました。
新しいAPIキーのユーザーインターフェース(「APIキー」タブ)では、現在のキーの無効化と新しいキーの作成の両方を行いたい場合、これら2つのアクションを別々に行う必要があります。
APIキーの名前の変更
APIキーの名前は変更できます。2つのAPIキーに同じ名前を付けることも可能です。
キーが有効であるか無効であるかに関わらず、APIキーの名前は変更できます。
APIキーのコピー
APIキーはクリップボードにコピーできます。セキュリティ上の理由から「APIキー」タブではAPIキーは一部しか表示されません。APIキーの全体を表示するには、APIキーをコピー&ペーストします。キーが有効であるか無効であるかに関わらず、APIキーはコピーできます。
各キーの利用レポートをダウンロードする
選択した期間中に各キーで翻訳した文字数をCSVレポートとして作成します。現在、選択できる期間は以下のとおりです。
直近24時間
直近7日間(当日を含む)
直近30日間(当日を含む)
今月(当日を含む)
先月
現在の利用期間(当日を含む)
前回の利用期間
文書翻訳のデータは、2024年5月16日00:00(UTC)以降の期間を対象としたレポートにのみ含まれます。ご注意ください。テキスト翻訳のデータはすべての期間のレポートに含まれます。
キーごとの使用量は請求書には記載されず、現時点ではCSVをエクスポートする形でのみ確認可能です。
キーごとの利用レポートをダウンロードするには、「APIキー」タブの「各キーの利用レポートをダウンロード」(Download key-level usage report) のボタンをクリックしてください。または、「ご利用状況」タブの中の「レポートをダウンロード」(Download report) のリンクをクリックしてください。
レポートの期間を選択し、「レポートをダウンロード」(Download your report) をクリックすると、CSVレポートをダウンロードできます。
新しいインターフェイスで複数のAPIキーに関するアクションをしたことがないのに、「APIキー」タブに無効化されたキーが表示されるのはなぜですか?
2023年12月より、今までのAPIキーのユーザーインターフェイスで「新しい認証キーを作成する」(下記の画像を参照)をクリックして新しいAPIキーを作成した場合、古いキーのステータスは「無効」になり、「APIキー」タブに無効化されたキーが表示されるようになりました。キーの名前は変更することもできます。
APIキーごとに料金の上限を設定できますか?
現在APIキーごとに料金の上限は設定できません。API Proにご登録のお客様は、アカウントごとに料金を管理できます。
用語集は特定のAPIキーのみに適用されますか?例えば、APIキー「A」を使って用語集を作成した場合、その用語集を使って翻訳できるのはAPIキー「A」のみですか?
用語集は、特定のAPIキーのみに適用されることはありません。ご使用のアカウントで有効なすべてのAPIキーは、用語集の管理や翻訳に使用できます。
複数のAPIキーを作成すると、APIアカウントで作成できる用語集の制限(1,000個)に影響しますか?
用語集の制限(1,000個)はアカウントごとであるため、複数のAPIキーを作成しても用語集の制限に影響はありません。
APIキーが最後に使用された日時を確認できますか?
APIキーが最後に使用された日時を確認することはできません。しかし、将来的にこの機能の追加を検討しています。
APIキーごとの使用量(各APIキーで翻訳した文字数)を確認することはできますか?
はい、キーごとの使用量をCSVレポートとしてエクスポートできます。「各キーの利用レポートをダウンロードする」のセクションをご覧ください。
AdvancedまたはUltimateプランに登録しています(APIには登録していません)。CATツールで使えるキーを複数作成できますか?
AdvancedまたはUltimateプランに登録しているだけでは、CATツールで使えるキーを複数作成することはできません。キーを複数作成するには、DeepL API ProまたはDeepL API Freeにご登録ください。