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

以降のセクションで説明する方法で、アプリを登録して API キーを管理します。

はじめに

アプリ登録は、API にアクセスできるユーザーを制御するための主要なメカニズムです。

API プロダクトを管理するで説明されているように、API をバンドルする API プロバイダとして、1 つ以上の API プロダクトを作成します。アプリ登録時に、アプリ デベロッパーは、使用する API プロダクトを選択し、Apigee は、そのデベロッパーが API プロダクトへのアクセスに使用できる単一の API キーを提供します。アプリ デベロッパーは、各呼び出しの API キーを API プロダクトに含まれる API プロキシに渡します。アプリ デベロッパーが、そのアプリで参照される API プロダクトすべて(または一部)にアクセスできなくなるように、いつでもアプリの API キーを取り消すことができます。

通常、アプリ デベロッパーは、デベロッパー ポータルを使用して API プロダクトを使用するよう登録します。ポータルを構築して API プロダクトを公開する手順については、ポータルの構築をご覧ください。

あるいは、API プロバイダがアプリ登録プロセスをより一層制御する必要がある場合、以降のセクションの説明に従って、API プロバイダは Apigee でアプリを登録することを選択できます。たとえば、社内の開発チームにアプリを登録する場合や、ポータルにアクセスできないデベロッパーに代わってアプリを登録する場合です。

以降のセクションでは、UIAPI を使用してアプリを登録し、API キーを管理する方法について説明します。

[Apps] ページの詳細

Apigee UI を使用して [Apps] ページにアクセスするには:

  1. Apigee UI にログインします。
  2. 左側のナビゲーション バーで [Publish > Apps] を選択します。
  3. [Apps] ページが表示されます。

    図でハイライト表示されているように、[Apps] ページでは次の操作を行うことができます。

アプリの登録

アプリを登録するには、次のいずれかの方法を使用できます。

  • アプリ デベロッパーによるポータルの操作方法で説明されている手順で、アプリ デベロッパーはポータルからアプリを登録できます。
  • 下記で説明されているとおり、Apigee でアプリを登録できます。キーをアプリ デベロッパーに提供する方法は、ご自身で決定します。

登録されたアプリは以下に追加されます。

Apigee でアプリを登録するには:

  1. [Apps] ページにアクセスします。
  2. [+ App] をクリックします。
  3. [App Details] に次の情報を指定します。
    項目 説明 必須
    名前 アプリの名前。アプリの作成後に名前を変更することはできません。この名前は Apigee API 呼び出しで使用されます。
    表示名 Apigee UI とデベロッパー ポータルに表示されるアプリの表示名。 ×
    Company / Developer

    : Apigee ハイブリッドでは会社のアプリはサポートされていないため、このフィールドは適用されません。

    [Company] または [Developer] を選択し、プルダウンからカンパニー名またはデベロッパー名を選択します。
    注: パフォーマンス上の理由から、すべての会社やデベロッパーがプルダウンに表示されるわけではありません。検索ボックスに会社名、デベロッパー名、またはメールアドレスを入力します。アプリ デベロッパーの登録するもご覧ください。

    コールバック URL 通常は、クライアント アプリに代わって認証コードを受け取るように指定されたアプリの URL を指定します。この値は、一部の API プロダクトでは不要です。 ×
    アプリを説明するメモ。 ×
  4. API キーの有効期限、ステータス、関連付けられた API プロダクトなどの認証情報を指定します。
    [Credentials] セクションで をクリックし、次の情報を入力します。
    項目 説明
    期限 有効期間または日付を構成するか、API キーを無期限に設定し、[OK] をクリックします。
    サービス 1 つ以上の API プロダクトを API キーに関連付けます。
    1. [Add product] をクリックします。
    2. リストから 1 つ以上の API プロダクトを選択します。
    3. [追加] をクリックします。
    4. 各 API プロダクトの [Status] を [Approved] に設定して承認するか、または [Revoked] に設定して取り消します。
    5. さらに API プロダクトを追加する手順を繰り返します。
  5. カスタム属性を指定します。
    1. [Custom Attributes] セクションで をクリックします。
    2. 名前と値を入力します。
    3. [Add] または [Add & Start another] をクリックします。
      追加できるカスタム属性の最大数は 18 です。
  6. [作成] をクリックします。

アプリに関連付けた API プロダクトで API キーの手動承認が必要とされている場合は、API キーを承認する、または取り消すの説明に従って API キーを承認します。

デベロッパーの登録済みアプリを表示する

特定のデベロッパーに登録されたアプリを表示するには、次のいずれかの方法を使用します。

アプリを表示して編集する

アプリを表示して編集するには:

  1. [Apps] ページにアクセスします。
  2. 表示して編集するアプリの行をクリックします。
    アプリの詳細が表示されます。
  3. アプリを編集するには、[編集] をクリックします。
  4. 次のタスクを実行します。
  5. [保存] をクリックします。

認証情報の管理

アプリを編集する際は、次の図に示すように、[Credentials] セクションでアプリの認証情報を管理できます。

上の図でハイライト表示されているように、[Credentials] セクションでは UI を使用して次のタスクを行うことができます。

API を使用して認証情報を管理する場合は、以下のセクションをご覧ください。

API キーとシークレットの表示

API キーとシークレットを表示するには:

  1. [Apps] ページにアクセスします。
  2. API キーとシークレットを表示するアプリの行をクリックします。
  3. [Credentials] セクションで、表示する API キーまたはシークレットに関連する [Show] をクリックします。

API キーの承認または取り消し

API プロキシに対して API 呼び出しを行うには、通常、API キーが必要です。Apigee では、API キーが承認され、有効であり、API を含む API プロダクトで定義された条件を満たす場合にのみ、呼び出しが許可されます。

API プロダクトを管理するの説明に従って、API キーを自動的に承認するように API プロダクトを構成できます。ただし、API プロダクトで API キーの手動承認が必要な場合は、キーを手動で承認する必要があります。

すべての API プロダクトまたは特定の API プロダクトについて、API キーを取り消すことができます。この場合、API キーとシークレットは無効であり、関連付けられている API プロダクトの API へのアクセスに使用できません。API キーはいつでも再承認できます。

API キーを承認する、または取り消すには:

  1. [Apps] ページにアクセスします。
  2. 表示して編集するアプリの行をクリックします。
  3. [編集] をクリックします。
  4. 次のいずれかのタスクを行います。
    • API キーに関連付けられている API プロダクトのすべてについて API キーを承認または取り消すには、その API キーに対応する [Approved] または [Revoked] を選択します。
    • 特定の API プロダクトの API キーを承認または取り消すには、API プロダクトの [Status] 列で [Approved] または [Revoked] を選択します。
  5. [保存] をクリックします。

アプリ内の API プロダクトの管理

アプリ内の API プロダクトを管理するには、次のタスクを行います。

アプリに API プロダクトを追加する

アプリに API プロダクトを追加するには:

  1. [Apps] ページにアクセスします。
  2. 表示して編集するアプリの行をクリックします。
  3. [編集] をクリックします。
  4. 次のいずれかのタスクを行います。
    • API プロダクトを新しい API キーに追加するには、 をクリックして新しい認証情報を生成し、有効期限を選択して、その API プロダクトを API キーに追加します。
    • API プロダクトを既存の API キーに追加するには、[Credential] セクションで [Add product] をクリックし、プルダウン リストから API プロダクトを選択します。
  5. [保存] をクリックします。

アプリから API プロダクトを削除する

API キーを有効にしたまま、1 つの API プロダクトでその API キー使用を許可しないようにする場合は、関連付けられた認証情報から削除できます。

  1. [Apps] ページにアクセスします。
  2. 表示して編集するアプリの行をクリックします。
  3. [編集] をクリックします。
  4. API プロダクトの隣にある をクリックします。
  5. [保存] をクリックします。

削除したプロダクトは再度追加できます。

新しい認証情報の生成

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

新しい API キーを生成するには:

  1. [Apps] ページにアクセスします。
  2. 表示して編集するアプリの行をクリックします。
  3. [編集] をクリックします。
  4. [Credentials] セクションで をクリックします。
  5. 有効期限を指定し、API プロダクトを追加して、そのステータスを設定します。
  6. 必要に応じて、他の API キーを取り消します。
  7. [保存] をクリックします。

アプリの承認または取り消し

アプリを承認または取り消すには、以下の手順に従います。アプリを取り消すと、承認済みの API キーは Apigee への API 呼び出しで使用できなくなります。アプリを再承認すると、承認済みの有効なすべての API キーを使用して API 呼び出しを行えます。

アプリが他の組織でも登録されている場合は、それらの組織それぞれでアプリを取り消す必要があります。この変更がすべてのメッセージ プロセッサで認識されるまで、数分かかることがあります。

アプリを承認する、または取り消すには:

  1. [Apps] ページにアクセスします。
  2. 表示して編集するアプリの行をクリックします。
  3. [編集] をクリックします。
  4. [App Status] フィールドで [Approve] を選択してアプリを承認するか、[Revoke] を選択してアプリを取り消します。
  5. [保存] をクリックします。

アプリの削除

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

今後、そのデベロッパー アプリを復元することを検討している場合は、削除する代わりに、アプリを取り消すこともできます。

アプリを削除するには:

  1. [Apps] ページにアクセスします。
  2. 削除するアプリの行にカーソルを合わせます。
  3. [Actions] 列にある をクリックします。

: Apigee では、デベロッパー アプリと関連するアーティファクトの削除は非同期で行われます。デベロッパー アプリはすぐに削除されますが、そのデベロッパー アプリに関連付けられているリソース(アプリキーやアクセス トークンなど)が自動的に削除されるまでには数秒から数分かかります。

API を使用してアプリの登録し、API キーを管理する

API を使用してアプリを登録して管理するには、デベロッパー アプリの登録をご覧ください。 API リファレンス ドキュメントの以下のセクションもご覧ください。

既存のコンシューマ キーとシークレットのインポートもご覧ください。