アプリの登録と API キーの管理

このトピックでは、Apigee Edge 管理 UI を使用してアプリを登録および管理する方法について説明します。このトピックで説明する手順には、組織管理者の役割を持つ Edge ユーザー、またはデベロッパー アプリを作成および編集する十分な権限を付与する役割が必要です。

デベロッパー アプリとは

API プロバイダとして、API プロダクトの作成で説明されているように、API をバンドルする 1 つ以上の API プロダクトを作成したとします。通常、API を使用したいデベロッパーは、デベロッパー ポータルにアクセスして、API を使用するために登録します。登録時に、デベロッパーは使用する API プロダクトを選択できます。たとえば、無料で提供されるプロダクトもあれば、サービスプランに応じて支払いが必要なプロダクトもあります。完了すると、この登録ステップによって、デベロッパー アプリと呼ばれる Edge エンティティが生成されます。デベロッパー アプリには、デベロッパーが選択したプロダクトと、デベロッパーがこれらのプロダクトに関連付けられた API にアクセスするために使用する必要がある一連の API キーが含まれています。デベロッパー ポータルの詳細については、デベロッパー ポータルとは をご覧ください。

ただし、デベロッパー ポータルはデベロッパー アプリを作成する唯一の方法ではありません。Edge 組織管理者や適切な権限を持つ別の個人は、Edge UI で直接デベロッパー アプリを作成することもできます。API プロバイダとして、アプリ登録プロセスの完全な制御を維持し、Edge 管理 UI を使用してアプリを登録することを選択する場合があります。たとえば、社内の開発チーム用に、またはポータルにアクセスできないデベロッパーの代わりに、アプリを登録する場合があります。ポータルでの登録と同様に、Edge UI でアプリを登録する場合は、登録を行うユーザーがアプリに関連付ける API プロダクトを決定します。アプリが登録されると、選択した API プロダクトへのアクセス権を付与するために API キーが Edge によって自動的に生成されます。そのキーをアプリ デベロッパーに渡す方法については、API プロバイダが決定します。アプリに関連付ける追加の API プロダクトすべてで、同じキーが使用されることに注意してください。

アプリによって、API プロバイダが API にアクセスできるユーザーを制御するための主要なメカニズムが提供されます。適切な Edge 組織の権限を持つユーザーは、いつでもアプリのキーを取り消して、そのアプリによって参照されるすべての API プロダクトにアクセスできなくすることができます。または、アプリに関連付けられた単一の API プロダクトへのアクセスを取り消すことができます。


組織管理者(または適切な役割の権限を持つユーザー)は、Edge 管理 UI の [Publish] > [Developer Apps] 概要ページで、組織のすべてのアプリを確認できます。このページには、各アプリのパフォーマンス データと、アプリキーの一般情報が表示されます。特定のアプリを表から選択し、そのアプリでアクセスできる API プロダクトやそれらのプロダクトで公開されるリソースなどの詳細情報を取得できます。アプリに関連付けられているキーを確認することもできます。

Edge 管理 UI でアプリを登録する

注: これらのタスクを行うには、組織管理者または十分な役割の権限を持つユーザーである必要があります。

アプリを登録するには:

  1. Edge 管理 UI(https://enterprise.apigee.com)にログインします。
  2. [Publish] タブ、[Developer Apps] の順にクリックします。
  3. [Developer Apps] ページで [(+) Developer App] をクリックします。
  4. アプリの名前を入力します。これは、後で管理 API 呼び出しで使用できる内部名です。アプリの作成後は、名前を変更できません。
  5. [Display Name] が管理 UI に表示されます。これは、デベロッパー ポータルでデベロッパーに表示されるアプリ名です。API 管理者とデベロッパーは、表示名をいつでも変更できます。
  6. [Developer] リストからデベロッパーを選択します。
    アプリは登録済みのデベロッパーに関連付ける必要があります。デベロッパーがリストに表示されていない場合は、そのデベロッパーを登録できます。詳しくは、アプリ デベロッパーの管理をご覧ください。
  7. 必要に応じて、[Callback URL] を入力します。
    コールバック URL とは、アプリに属するリソースの場所です。たとえば、OAuth を使用している場合は、ユーザーがユーザー名とパスワードを入力するログイン画面の場所になることがあります。この値は、一部の API プロダクトでは不要です。
  8. 必要に応じて、アプリの説明を追加します。
  9. [Credentials] セクションは「API キー」を意味します。アプリの作成時に自動的に生成される API キーの有効期限(時刻または日付)を設定します。次に、1 つ以上の API プロダクトをキーに関連付けます。デベロッパーは、これらの API プロダクトに含まれている API プロキシの呼び出しごとに API キーを渡します。アプリの作成後、アプリを編集して有効期限が異なる認証情報 / キーとプロダクトを追加します。詳しくは、API プロダクトの作成をご覧ください。
  10. アプリのカスタム属性を追加します。最大 18 個追加できます。カスタム属性ごとに、次の操作をします。
    • [(+) Add Custom Attribute] をクリックします。
    • 属性の名前と値を追加します。
  11. [Save] をクリックします。
    アプリが [Developer Apps] ページのアプリリストに追加されます。
  12. アプリに関連付けたプロダクトに API キーの手動の承認が必要な場合:
    1. 新しいアプリの名前をクリックします。
    2. [Edit] をクリックしてアプリを編集します。
    3. [Consumer Key] と [Consumer Secret] の横にある [Approve] をクリックします。

Edge 管理 UI でアプリを編集する

注: これらのタスクを行うには、組織管理者または十分な役割の権限を持つユーザーである必要があります。

アプリを編集するには:

  1. メニューで、[Publish] > [Developer Apps] > [developer_app_name] を選択します。
  2. [Edit] をクリックします。
  3. 構成を変更します。
    注: カスタム属性を編集する場合は注意してください。カスタム属性に依存するシステムがある場合があります。
  4. [Save] をクリックします。

Core Persistence Services のキャッシュ下限値: Core Persistence Services(CPS)を有効にしている組織では、以下のエンティティが、アクセス後最低 180 秒間にわたり Edge によってキャッシュに保存されます。

  • OAuth アクセス トークン。つまり、OAuth v2 ポリシーの ExpiresIn 要素を使っても、アクセス トークンを 180 秒未満で期限切れにすることはできません。
  • Key Management Service(KMS)エンティティ(アプリ、デベロッパー、API プロダクト)。
  • OAuth トークンと KMS エンティティのカスタム属性。

API キーを管理する

注: これらのタスクを行うには、組織管理者または十分な役割の権限を持つユーザーである必要があります。

API プロキシに対して API 呼び出しを行うには、通常は API キーが必要です。Edge では、API キーがアクティブおよび有効であり、API を含む API プロダクトによって定義された条件を満たす場合にのみ、呼び出しは受け入れられます。

API キーを承認する

API プロダクトで API キーの [Automatic] の承認が構成されている場合は、何もする必要はありません。ただし、プロダクトで API キーの手動の承認が必要な場合は、次の手順に従います。

  1. メニューで、[Publish] > [Developer Apps] > [developer_app_name] を選択します。
  2. [Edit] をクリックしてアプリを編集します。
  3. 対応するプロダクトの [Approve] をクリックします。
  4. [Save] をクリックします。

管理 API を使用して API キーを承認することもできます。

API キーを取り消す

API キーを取り消すことができます。これは、特定のキーとシークレットが、関連する API プロダクトの API にアクセスするために有効ではなくなることを意味します。[Approve] をクリックして、いつでもアクセスを再度有効にすることができます。

(キーを承認されたままにする一方、特定のプロダクトで使用されないようにする場合は、次のセクション「API キーから API プロダクトを取り消すか削除する」をご覧ください)。

  1. メニューで、[Publish] > [Developer Apps] > [developer_app_name] を選択します。
  2. [Edit] をクリックしてアプリを編集します。
  3. キーおよびシークレットと同じ行で、[Revoke] をクリックします。
  4. [Save] をクリックします。

管理 API を使用して API キーを取り消すこともできます。

API キーを削除する

API キーを削除すると、キーとシークレットが削除され、これらを関連するプロダクトの API に対する API 呼び出しで使用できなくなります。

  1. メニューで、[Publish] > [Developer Apps] > [developer_app_name] を選択します。
  2. [Edit] をクリックしてアプリを編集します。
  3. 対応するプロダクトの [Remove] をクリックします。
  4. [Save] をクリックします。

管理 API を使用して API キーを削除することもできます。

新しいキーを生成する

デベロッパー アプリの新しい API Key-Secret のペアを生成できます。たとえば、API キーのローテーションを使用する場合、有効期限が切れたときにローテーションから外れるキーと重複する新しいキーを生成できます。元の Key-Secret のセキュリティが侵害された場合に、新しいKey-Secretを生成する場合もあります。新しいキーを生成した場合、既存の API キーは期限切れになるか明示的に取り消されるまで機能し続けます。

  1. メニューで、[Publish] > [Developer Apps] > [developer_app_name] を選択します。
  2. [Edit] をクリックします。
  3. [+ Credential] をクリックして、新しい API キーを任意の有効期限で生成し、1 つ以上の API プロダクトをそのキーに関連付けます。
  4. この画面では、[Revoke] および [Remove] ボタンを使用して、他の API キーを取り消したり削除したりすることもできます。これにより、キーは使用できなくなります。取り消したキーは、後で再度承認して使用できます。削除したキーは、削除されます。
  5. [Save] をクリックします。

管理 API を使用して新しい API キーを生成するには、デベロッパー アプリの新しいキーペアの生成をご覧ください。

カスタムキーを作成する場合(次の手順)、この手順ではそれらのキーは再生成されません

既存の API キーを読み込む、またはカスタムキーを作成する

Edge に読み込む既存のコンシューマ キーとシークレットがあるか、カスタム API キーを作成する場合は、既存のコンシューマ キーとシークレットの読み込みをご覧ください。

API プロダクトを管理する

デベロッパー アプリで API プロダクトを管理するには、次のタスクを行います。

API プロダクトをデベロッパー アプリに追加する

API プロダクトをデベロッパー アプリに追加するには:

  1. メニューで、[Publish] > [Developer Apps] > [developer_app_name] を選択します。
  2. [Edit] をクリックします。
  3. API プロダクトを新しい API キーに追加するには、[+ Credential] をクリックして新しい API キーを生成し、任意の有効期限を選択して、API プロダクトをそのキーに追加します。
  4. API プロダクトを既存の API キーに追加するには、[API key] セクションで、[+ Product] を選択して、プルダウン リストから API プロダクトを選択します。
  5. [Save] をクリックします。

API プロダクトを取り消す、またはデベロッパー アプリから削除する

API キーをアクティブなままにする一方、1 つ以上の API プロダクトで使用できないようにする場合は、API キーに関連付けられたプロダクトを取り消すか削除できます。取り消す場合、プロダクトは API キーに関連付けられたままですが、そのプロダクトでキーは使用できません。削除する場合、API プロダクトは API キーとの関連付けが完全に解除されます。

  1. メニューで、[Publish] > [Developer Apps] > [developer_app_name] を選択します。
  2. [Edit] をクリックしてアプリを編集します。
  3. 目的のプロダクトの横にある [Revoke] または [Remove] をクリックします。
  4. [Save] をクリックします。

取り消したプロダクトを再度承認するか、削除したプロダクトを再度追加できます。

この手順に管理 API を使用することもできます。API キーの API プロダクトの承認または取り消しおよび特定のキーの API プロダクトの削除をご覧ください。

デベロッパー アプリを取り消す

注: これらのタスクを行うには、組織管理者または十分な役割の権限を持つユーザーである必要があります。

デベロッパー アプリを取り消すと、承認済みの API キーは Edge への API 呼び出しで使用できなくなります。[Developer App Details] ページでは、API キーのキーステータス ラベルが取り消し線テキストで表示されます([Approved] または [Revoked])。ラベルにマウスカーソルを置くと、アプリが取り消されていることがツールチップに表示されます。アプリを再度承認すると、API キーステータスの取り消し線テキストが消え、承認された API キーが再び有効になります。

管理 UI でのデベロッパー アプリの取り消し

  1. [Publish] > [Developer Apps] > [app] > [Edit] を選択します。
  2. [App Status] 項目で [Revoke] をクリックします。
  3. [Save] をクリックします。

変更がすべてのメッセージ プロセッサで認識されるまでに数分かかることがあります。それまでは、API キーを使用する一部の呼び出しが引き続き受け入れられる可能性があります。

Management API でのデベロッパー アプリの取り消し

デベロッパー アプリの承認または取り消しをご覧ください。

アプリが他の組織で登録されている場合は、それらの各組織でも取り消す必要があります。

デベロッパー アプリを再度承認するには、アプリを編集して [App Status] 項目で [Approve] をクリックします。これにより、承認されたすべての API キーが使用可能になります。この場合も、変更がすべてのメッセージ プロセッサで認識されるまでに数分かかることがあります。

Edge 管理 UI でアプリを削除する

注: これらのタスクを行うには、組織管理者または十分な役割の権限を持つユーザーである必要があります。

アプリを削除すると、そのアプリに関連付けられているすべてのクライアント キーが無効になります。リクエストで無効なキーを使用すると、リクエストは失敗します。

アプリを削除するには:

  1. メニューで、[Publish] > [Developer Apps] を選択します。
  2. アプリの横にある [Delete] をクリックし、確認ダイアログで [Delete] をクリックします。

[Developer Apps] ページを検索する

検索メニューには、アプリ ファミリーやコンシューマ キーなど、特定のデベロッパー アプリ属性を検索するために使用できるプルダウン メニューがあります。