クライアント アプリの登録

このページは Apigee と Apigee ハイブリッドに適用されます。

Apigee Edge のドキュメントを表示する。

Apigee の OAuth 2.0 フローに参加するには、クライアント アプリの登録が必要です。

登録とは

登録することで、Apigee（認証サーバー）がアプリを一意に識別できるようになります。アプリを登録すると、クライアント ID とクライアント シークレットという 2 つのキーが返されます。このアプリでは、認証サーバーとのアクセス トークンのネゴシエーション時にこれらのキーが必要になります。

簡単な手順

新しいアプリを登録するには、[アプリ] ページで次の操作を行います。

Apigee Cloud コンソール

  1. Google Cloud コンソールで、[配布] > [アプリ] ページに移動します。

    [アプリ] に移動

  2. [作成] をクリックします。
  3. 次の表の説明に従って、アプリの詳細を指定します。
    フィールド 説明 必須かどうか
    アプリ名 アプリの名前。アプリの作成後、この名前を変更することはできません。この名前は Apigee API の呼び出しで使用されます。 必須
    表示名 Apigee UI とデベロッパー ポータルに表示されるアプリの表示名。 省略可
    デベロッパー

    プルダウンからデベロッパー名を選択します。

    注: パフォーマンス上の理由から、すべてのデベロッパーがプルダウンに表示されるわけではありません。検索ボックスにデベロッパー名またはメールアドレスの入力を開始すると、入力しているテキストに合わせてプルダウン値が自動的に調整されます。アプリ デベロッパーを登録するもご覧ください。

    		 必須
    コールバック URL 通常は、クライアント アプリに代わって認証コードを受け取るように指定されたアプリの URL を指定します。この値は、一部の API プロダクトでは不要です。 省略可
    注 アプリを説明するメモ。 省略可
  4. API キーの有効期限、ステータス、関連付けられた API プロダクトなどの認証情報を指定します。[認証情報] セクションで [認証情報の追加] をクリックし、次の情報を入力します。
    フィールド 説明
    有効期限 有効期間または日付を選択するか、API キーを無期限に設定します。
    プロダクト 1 つ以上の API プロダクトを API キーに関連付けます。
    1. [ 商品を追加] をクリックします。
    2. リストから 1 つ以上の API プロダクトを選択します。
    3. [OK] をクリックします。
    4. [追加] をクリックします。
  5. 各 API プロダクトの [ステータス] を「承認済み」に設定して承認するか、「取り消し済み」に設定して取り消します。手動承認が必要な API プロダクトを認証情報に追加した場合は、「Pending approval status」と表示されます。それ以外の場合は、「Approved」が表示されます。このステップでは、承認ステータスを変更できます。
    1. [認証情報] セクションの [プロダクト] のリストから、1 つ以上のプロダクトを選択します。
    2. [承認] または [取り消す] をクリックします。
  6. [作成] をクリックします。
  7. デベロッパー アプリのリストで新しいアプリを探し、選択します。
  8. をクリックすると、[キー]（クライアント ID）と [シークレット]（クライアント シークレット）の値が表示されます。

従来の UI

  1. 次の手順で [Developer Apps] ページにアクセスします。

    [Developer Apps] ページにアクセスするには:

    1. Apigee UI を開きます。
    2. 左側のナビゲーション バーで [Publish] > [Apps] を選択します。
    3. [+ App] をクリックします。
    4. フォームに必要事項を記入します。
      1. アプリの名前と表示名を入力します。
      2. デベロッパーを選択します（デフォルト デベロッパーのいずれかを選択するか、独自のデベロッパーを作成します）。
      3. （省略可）コールバック URL を入力します。これは、3-legged OAuth 権限付与タイプのフローに使用されます。リソース サーバーとの認証（ログイン）が完了すると、Apigee はここにユーザーをリダイレクトします。コールバック URL は完全な URL である必要があるため、https://www.example.com のように入力します。3-legged OAuth の詳細については、認証コードの権限付与タイプを実装するをご覧ください。
      4. API プロダクトを追加します。既存のプロダクトを選択することも、独自のプロダクトを作成することもできます。
      5. 現時点では、[Custom Attributes] セクションはスキップしてください。
      6. [Create] をクリックします。
    5. デベロッパー アプリのリストで新しいアプリを探し、選択します。
    6. [Show] をクリックすると、コンシューマ ID（クライアント ID）とコンシューマ シークレット（クライアント シークレット）の値が表示されます。

詳細

アプリ登録の詳細については、アプリを登録して API キーを管理するをご覧ください。API プロダクトのロールの詳細については、API プロダクトとはをご覧ください。