このページは Apigee と Apigee ハイブリッドに適用されます。
Apigee Edge のドキュメントを表示します。
以降のセクションに示す方法で、アプリ デベロッパーを登録して管理します(アプリ登録はこれとは別のプロセスです。これについては、アプリ登録を使用した API へのアクセス管理をご覧ください)。
はじめに
Apigee が提供する多くの利点は、API の呼び出し元を識別することに完全に依存するものです。たとえば、API セキュリティ、トラフィック管理、相当量の分析データは、呼び出し元を識別することに依存しています。Apigee はどのようにして API の呼び出し元を識別するのでしょうか。ユーザー ID、API キー、OAuth トークンなど、各 API 呼び出しの固有の情報を読み取ることで識別しています。その固有情報に基づいて、API プロキシに組み込んだ機能をロックまたはロック解除し、API へのアクセスと API の動作を完全に制御できます。
そのため、アプリ デベロッパーは API を使用するために登録が必要となります。登録されると、デベロッパーはアプリを登録し、使用する API を選択し、API へのアクセスに必要な固有の API 認証情報(コンシューマ キーとコンシューマ シークレット)を受け取ります。
アプリ デベロッパーの登録方法
アプリ デベロッパーを登録するには、次のいずれかの方法に従います。
- 有料の Apigee アカウントがある場合、デベロッパーはデベロッパー ポータルを通じて、自身で登録できます。詳細については、デベロッパー ポータルのタイプに応じて、次のいずれかのセクションをご覧ください。
- 統合ポータル: 統合ポータルでのユーザー アカウントの作成
- Drupal 10: アプリ デベロッパーを登録する
- 管理者は、API を使用してアプリ デベロッパーを登録できます。
- デベロッパー ポータルの管理者として、次のセクションの説明に従ってポータル上でデベロッパーを直接管理できます。
- 統合ポータル: ユーザー アカウントを管理するユーザーの管理。
- Drupal 10: アプリ デベロッパーにより Apigee Edge モジュールが操作される仕組みを理解する
- 組織管理者は、以降のセクションの説明に従って Apigee UI または API を使用してデベロッパーを管理します。
デベロッパー ポータルでユーザー アカウントを管理するおすすめの方法
Apigee では、デベロッパー ポータルでユーザー アカウントを直接管理することをおすすめしています。
統合ポータルを使用している場合、これが統合ポータルと Apigee のユーザー アカウントを常に同期状態に保つ唯一の手段となります。
Drupal ベースのデベロッパー ポータルを使用する場合、デベロッパー ポータルでユーザー アカウントを直接管理することには、次のようなメリットがあります。
- ポータルの管理者インターフェースを使用してデベロッパーを追加すると、そのデベロッパーのポータル用パスワードを設定し、デベロッパーに送信される自動メール メッセージをトリガーできます。
Apigee を使用してデベロッパーを追加または変更すると、デベロッパーにはメールが送信されず、ポータル上でのデベロッパーのパスワードの設定もできません。したがって、デベロッパーがポータルにログインするには、その前にポータル上でデベロッパーのパスワードをリセットする必要があります。
- ポータルでデベロッパーのアカウントに加えられた変更はすべて、Apigee に自動的に送信されます。
Apigee を使用して Drupal ベースのユーザー アカウントを管理する場合は、ポータルと Apigee の間でアプリ デベロッパーを同期する必要があります。
デベロッパー ページの詳細
Apigee UI を使用して、[Developers] ページにアクセスしてページの内容を調べます。
[Developers] ページにアクセスするには:
- Cloud コンソールの Apigee UI を使用している場合: [Distribution] > [Developers] を選択します。
- 従来の Apigee UI を使用している場合: [Publish] > [Developers] を選択します。
[Developers] ページでは、以下のことができます。
- デベロッパーを追加する
- 以下のようなデベロッパーの詳細を表示して編集する
- 公開データをエクスポートする
- デベロッパーを削除する
- デベロッパーのリストを検索する
デベロッパーの追加
デベロッパーを追加するには:
- [Developers] ページにアクセスします。
- [+ Developer] をクリックします。
- デベロッパーの名、姓、メールアドレス、ユーザー名などの詳細を入力します。
- [Create] をクリックします。
ユーザーの管理もご覧ください。
デベロッパーの詳細の表示と編集
デベロッパーの詳細を表示して編集します。
デベロッパーの詳細を表示して編集するには:
- [Developers] ページにアクセスします。
- 表示して編集するデベロッパーの行をクリックして、デベロッパーの詳細を開きます。
- [Details] セクションに次の情報が表示されます。必要に応じてデベロッパーの詳細を編集します。
詳細 説明 詳細 デベロッパーの氏名、ユーザー名、メールアドレス、登録のステータスと期間、デベロッパー ID。
デベロッパーの詳細を編集するには、次のフィールドのいずれかをクリックします。- 名
- 姓
- メールアドレス
- ユーザー名
カスタム属性 デベロッパー用に定義されたカスタム属性。必要に応じてカスタム属性を構成します。詳細については、デベロッパーのカスタム属性の管理をご覧ください。 アプリ このデベロッパーによってすでに登録されたアプリ。アプリ登録を使用した API へのアクセスの管理をご覧ください。 - [Status] フィールドでデベロッパーをアクティブまたは非アクティブにします。
詳細については、デベロッパーのアクティブ化と非アクティブ化をご覧ください。
Apigee では、以下のエンティティはアクセスされてから最低 180 秒間、キャッシュに保持されます。
- OAuth アクセス トークン。OAuth v2 ポリシーの
ExpiresIn
要素によって、アクセス トークンを 180 秒未満で期限切れにすることはできません。 - Key Management Service(KMS)エンティティ(アプリ、デベロッパー、API プロダクト)。
- OAuth トークンと KMS エンティティのカスタム属性。
デベロッパーのカスタム属性の管理
デベロッパーごとに 18 個までのカスタム属性を追加します。
カスタム属性を管理するには:
- [Developers] ページにアクセスします。
- カスタム属性を管理するデベロッパーの行をクリックして、デベロッパーの詳細を開きます。
- [Custom Attributes] セクションで [+] をクリックします。
- 属性の名前と値を入力します。
- [] をクリックします。
- カスタム属性を削除するには、削除する属性にカーソルを合わせ、表示されるアクション メニューで をクリックします。
デベロッパーのアクティブ化と非アクティブ化
ポータルで自己登録するアプリ デベロッパーをデフォルトでアクティブ / 非アクティブのどちらにするかを、構成できます。
非アクティブになったデベロッパーは、依然としてデベロッパー ポータルにログインしてアプリを作成できますが、対応する API キーはどれも機能しません。デベロッパーのアプリは、デベロッパーが非アクティブの間は有効ではありませんが、承認済み(またはその他の)ステータスは API キーと同様に保持されます。
デベロッパーをアクティブまたは非アクティブにするには:
- [Developers] ページにアクセスします。
- アクティブまたは非アクティブにするデベロッパーの行をクリックして、デベロッパーの詳細を開きます。
- [Details] セクションで、[Status] フィールドを必要に応じて [Active] または [Inactive] に設定します。
- デベロッパーが複数の組織に属している場合は、上記の手順を繰り返します。
公開データをエクスポートする
次の公開データをコンマ区切り値(CSV)ファイルとしてエクスポートできます。
- デベロッパーの詳細
- デベロッパー、アプリケーション、API プロダクトの詳細
公開データをエクスポートするには:
- [Developers] ページにアクセスします。
- [Export CSV...] をクリックします。
- プルダウンから [Developers] または [Developers, Apps, and Products] を選択します。
選択した公開データが CSV ファイルとしてダウンロードされます。
デベロッパーの削除
デベロッパーを削除するには:
- [Developers] ページにアクセスします。
- 削除するデベロッパーの行にカーソルを合わせて、操作メニューを表示します。
- [] をクリックします。
- [削除] をクリックして削除を確定します。
ポータルと Apigee 間のアプリ デベロッパーの同期
Drupal ベースのデベロッパー ポータルを使用して API を公開している場合、Apigee を使用してアプリ デベロッパーに対して行った変更はポータルに反映されません。これらの変更をポータル上に反映させるには、ポータル管理者としてポータルにログインし、ポータルを Apigee と同期する必要があります。
Apigee で定義されたアプリ デベロッパーとデベロッパー ポータルを同期する方法については、次のセクションをご覧ください。
Drupal 10: デベロッパーと Apigee を同期するAPI を使用したデベロッパーの管理
Developer API を使用してデベロッパーを管理します。