デベロッパー ポータルでは、複雑な設定なしで、デベロッパー アカウントの作成、ログイン、API を使用するアプリの管理といった機能をポータル ユーザーにすぐに提供できます。
ここでは、ポータル ユーザーがポータルをどのように使用できるかについて説明します。
ポータルにログインする
以下のセクションでは、ポータル ユーザーがユーザー認証情報（組み込み ID プロバイダ）または SAML（ベータ版）を使用して統合ポータルにログインする方法について説明します。
組み込み ID プロバイダと SAML ID プロバイダの両方を有効にした場合は、ポータル ユーザーが好みのログイン方法を選択できます。例:
![ユーザー認証情報と SAML 認証が両方とも有効な場合の [Sign In] ダイアログ](https://docs.apigee.com/static/api-platform/images/saml-basic.png?authuser=00&hl=ja)
ユーザー認証情報（組み込み ID プロバイダ）を使用してポータルにログインする
組み込み ID プロバイダが有効な場合、ポータル ユーザーはユーザー認証情報（ユーザー名とパスワード）を使用して統合ポータルにログインできます。次のセクションをご覧ください。
統合ポータルでデベロッパー アカウントを作成する
組み込み ID プロバイダの場合、ポータル ユーザーは API を使用する前に統合ポータルでデベロッパー アカウントを作成する必要があります。
ポータル ユーザーは次の手順に従って、統合ポータルでデベロッパー アカウントを作成します。
- ポータルに移動します。
[Sign In] をクリックします。
[Sign In] ページが表示されます。
[Create Account] をクリックします。
[Create your account] ページが表示されます。
![[Create your account] ダイアログ](https://docs.apigee.com/static/api-platform/images/create-account.png?authuser=00&hl=ja)
フォームに入力します。
すべての必須フィールドに値を入力する必要があります。パスワードは 8 文字以上とし、少なくとも数字、英小文字、英大文字、特殊文字をそれぞれ 1 文字以上含める必要があります。
利用規約を読み、これに同意します。
[Create Account] をクリックします。
注: すでに登録されているメール ID を使ってアカウントを作成しようとすると、そのアカウントはすでに存在することを知らせるメッセージが表示され、そのユーザーでログインするよう促されます。
CAPTCHA フォームに入力し、[Verify] をクリックします（表示されている場合）。
デベロッパー アカウントが作成され、確認メールが送信されます。
注: メール通知を構成するに従って、確認メールを構成できます。ポータルをリリースする前に、ポータルから送信されるメール通知用に SMTP サーバーを構成することをおすすめします。SMTP サーバーを構成するをご覧ください。
10 分以内に確認メールのリンクをクリックして、登録プロセスを完了します。
10 分以内にリンクをクリックしなかった場合は、同じ手順をもう一度繰り返してアカウントを作成し、再度確認メールを受け取る必要があります。
統合ポータルにログインします（下記を参照）。
統合ポータルにログインする
組み込み ID プロバイダの場合、ポータル ユーザーは統合ポータルに登録して承認された後、認証情報（ユーザー名とパスワード）を使用してログインします。
ポータル ユーザーは次の手順に従ってログインします。
- ポータルに移動します。
- [Sign In] をクリックします。
- メールアドレスとパスワードを入力します。
- [Sign In] をクリックします。
パスワードを変更する
組み込み ID プロバイダでパスワードを変更する場合、ポータル ユーザーは次の手順に従います。
- ポータルに移動します。
- [Sign In] をクリックします。
- [Reset Password] をクリックします。
- パスワードを再設定するアカウントのメールアドレスを入力します。
[Send Reset Password Link] をクリックします。
パスワード再設定用のリンクがメールで送信されます。
注: SMTP サーバーを構成するには、SMTP サーバーを構成するをご覧ください。
確認メールのリンクをクリックします。
新しいパスワードを入力し、パスワードを確認します。
パスワードは 8 文字以上とし、少なくとも数字、英小文字、英大文字、特殊文字をそれぞれ 1 文字以上含める必要があります。
[Create New Password] をクリックします。
SAML 認証を使用してポータルにログインする（ベータ版）
SAML ID プロバイダが有効な場合、ポータル ユーザーは次の手順に従い、SAML 認証を使用して統合ポータルにログインします。
- ポータルに移動します。
- [Sign In] をクリックします。
[login with SAML] をクリックします。
SAML プロバイダにリダイレクトされます。
プロンプトが表示されたら、SAML ID プロバイダの認証情報を入力します。
API リファレンス ドキュメントを見る
ポータル ユーザーは次の手順に従って、ポータルに公開されている API リファレンス ドキュメントを閲覧することができます。
- ポータルに移動します。
- 上部のナビゲーション バーにある [APIs] をクリックします。
API リファレンス ドキュメントを見る API カードをクリックします。
API リファレンス ドキュメントが表示されます。ここで、その API がどのようなものであるかを理解し、API を試すことができます。
API を試すには、認可を受ける必要があります。
a. 上部のナビゲーション バーにある [Authorize] をクリックします。
b. 必要な認証情報を入力します。
c. [Authorize] をクリックします。
d. [OK] をクリックします。
API リファレンス ドキュメントのレンダリングに使用される OpenAPI 仕様をダウンロードするには、[Download Spec] をクリックします。API リファレンス ドキュメントがどのようにレンダリングされるかについては、API の公開をご覧ください。
デベロッパー チームを使用してアプリの責任を共有する（ベータ版）
ポータル ユーザーは、デベロッパー チームを使用してアプリの責任を他のポータル ユーザーと共有できます。以下のセクションで、デベロッパー チームの作成方法と管理方法について説明します。
デベロッパー チームのメンバーのロールについて
次のテーブルに、デベロッパー チームのメンバーに割り当てることができるロールをまとめます。
| ロール | 説明 |
|---|---|
| App Admin |
|
| Owner | デベロッパー チームのメンバー、デベロッパー チームの詳細、アプリに対する完全な読み取りおよび書き込み権限。 |
| Viewer | デベロッパー チームのメンバー、デベロッパー チームの詳細、アプリに対する読み取り専用権限。 |
Teams ページを表示する
[Teams] ページには、自分が所属しているデベロッパー チームが表示されます。
[Teams] ページにアクセスするには:
- ポータルにログインします。
- ポータルのデベロッパー アカウント プルダウンから [Teams] を選択します。
[Teams] ページが表示されます。ここでは次のことができます。
- 自分が所属しているデベロッパー チームの名前、ロール、メンバーリスト、チームの作成日を見る
- デベロッパー チームを追加する
- デベロッパー チームの行をクリックして、デベロッパー チームのメンバーとそのロールを編集する、自分自身をデベロッパー チームから除去する、またはチームを削除する
デベロッパー チームを追加する
デベロッパー チームを追加するには:
- ポータルにログインします。
- ポータルのデベロッパー アカウント プルダウンから [Teams] を選択します。
- [+ New Team] をクリックします。
- 名前、説明、メインの連絡先（デフォルトは、チームを作成しようとしているユーザーのメールアドレス）を入力します。
作成するデベロッパー チームにメンバーを追加するには、[+ Add another member] をクリックし、ポータル ユーザーのメールアドレスを入力してそのユーザーのロールを選択します。
同じ手順を繰り返して残りのメンバーを追加します。
注: チームを作成したユーザーは自動的にそのデベロッパー チームのオーナーとして追加されます。
デベロッパー チームからメンバーを削除するには、削除するメンバーの横の
をクリックします。[Create] をクリックします。
デベロッパー チームのメンバーとそのロールを編集する
デベロッパー チームのメンバーとそのロールを編集するには:
- ポータルにログインします。
- ポータルのデベロッパー アカウント プルダウンから [Teams] を選択します。
- 自分がオーナーである、編集するデベロッパー チームの行をクリックします。
必要に応じて次のことを行います。
- 名前、説明、メインの連絡先を編集します。
- デベロッパー チームのメンバーを追加または削除します。
- デベロッパー チームのメンバーのロールを更新します。
[Save] をクリックします。
自分自身をデベロッパー チームから除去する
自分自身をデベロッパー チームから除去するには:
- ポータルにログインします。
- ポータルのデベロッパー アカウント プルダウンから [Teams] を選択します。
- 自分自身を除去するデベロッパー チームの行をクリックします。
- [Leave Team] をクリックします。
デベロッパー チームを削除する
注: デベロッパー チームを削除すると、そのデベロッパー チームが所有しているアプリもすべて削除されます。
デベロッパー チームを削除するには:
- ポータルにログインします。
- ポータルのデベロッパー アカウント プルダウンから [Teams] を選択します。
- 削除するデベロッパー チームの行をクリックします。
をクリックします。- [Confirm] をクリックして削除を確定します。
アプリを登録する
以下のセクションに従って、デベロッパー アプリとデベロッパー チームアプリを登録します。
デベロッパー アプリを登録する
ポータル ユーザーは、次の手順に従って、公開されている API を使用するようにアプリを登録できます。
- デベロッパー アカウント プルダウンから [Apps] を選択します。
- [+ New App] をクリックして新しいアプリを作成します。
- [New App] ダイアログでアプリの名前と説明を入力します。
[Owner] プルダウン リストからアプリのオーナーを選択します。
注: このステップは、デベロッパー チームとオーディエンス管理機能のベータ版リリースに登録している場合にのみ適用されます。Apigee ハイブリッドには適用されません。ベータ版では、アプリを作成した後にアプリのオーナー権限を委譲することはできません。
デフォルトでは、アプリの作成者がオーナーになります。必要であれば、プルダウン メニューからデベロッパー チームを選択し、他のデベロッパー チームのメンバーとアプリの責任を共有します。デベロッパー チームを使用してアプリの責任を共有する（ベータ版）をご覧ください。
[API Catalog] セクションで、使用する API を 1 つ以上選択します。
カタログ内の API は、コールバック URL が必要な認証 API と、公開 API に分類されています。アプリを作成するには、少なくとも 1 つの API を選択する必要があります。
[Authenticated APIs] セクションで API を選択した場合は、コールバック URL を入力します。
詳細については、コールバック URL についてをご覧ください。
[Create] をクリックします。
デベロッパー チームアプリを登録する
デベロッパー チームのメンバーは、次の手順に従って、デベロッパー チームが公開されている API を使用するためのアプリを登録できます。
詳細については、次をご覧ください。
- ポータル ユーザーがチームを追加、管理する方法については、デベロッパー チームを使用してアプリの責任を共有する（ベータ版）をご覧ください。
- API プロバイダがデベロッパー チームを表示、管理する方法については、デベロッパー チームの管理をご覧ください。
デベロッパー チーム アプリを登録するには:
- デベロッパー アカウント プルダウンから [Teams] を選択します。
- アプリを登録するデベロッパー チームの行をクリックします。
- [+ New App] をクリックして新しいアプリを作成します。
- [New App] ダイアログでアプリの名前と説明を入力します。
[Owner] プルダウン リストからアプリのオーナーを選択します。
デフォルトでは、デベロッパー チームがアプリのオーナーになります。必要であれば、プルダウン メニューから別のデベロッパー チームまたは自分自身をオーナーとして選択します。
注: ベータ版リリースでは、アプリを作成した後にアプリのオーナー権限を委譲することはできません。
[API Catalog] セクションで、使用する API を 1 つ以上選択します。
カタログ内の API は、コールバック URL が必要な認証 API と、公開 API に分類されています。アプリを作成するには、少なくとも 1 つの API を選択する必要があります。
[Authenticated APIs] セクションで API を選択した場合は、コールバック URL を入力します。
詳細については、コールバック URL についてをご覧ください。
[Create] をクリックします。
アプリ内の API を管理する
API プロデューサーとして、API を公開し、ポータル ユーザーが API プロダクトを利用できるようにします。
ポータル ユーザーは、アプリが使用する API を管理します。選択した API はアプリ詳細ページに追加されます。API の中には、自動的に承認されないものがあります。ステータスが [Pending] の場合は、API へのアクセスがリクエストされているものの、まだ承認されていないことを示します。
ポータル ユーザーは次の手順に従って、ポータルからアプリ内の API を管理できます。
- デベロッパー アカウント プルダウンから [Apps] を選択します。
- リスト内のアプリをクリックします。
- [APIs] セクションでアクセス切り替えをクリックして、アプリからの API へのアクセスを有効または無効にします。
- 認証 API の場合は、必要に応じてコールバック URL を追加または編集します。
アプリの API キーとシークレットを表示する
ポータル ユーザーは次の手順に従って、アプリの API キーをポータルから管理できます。
- デベロッパー アカウント プルダウンから [Apps] を選択します。
- リスト内のアプリをクリックします。
- [API Keys] セクションに API キーが表示されます。
- API キーのステータスが [Active] であることを確認します。
- [Show] をクリックしてシークレットを表示します。
- API キーまたはシークレットにカーソルを合わせ、
をクリックしてクリップボードにコピーします。
アプリの API キーをローテーションする
ポータル ユーザーは、アプリの API キーを定期的に、または漏洩やセキュリティ侵害の可能性が見つかったときに、ローテーションできます。ポータル ユーザーが API キーをローテーションすると、元のキーと同じ API エンタイトルメントのままで新しい API キーが作成されます。元の API キーは、ユーザーが使用停止にしない限り引き続き有効になります。古い API キーの認証情報が受け入れられないようにするため、アプリの API キーを取り消すに従って古い API キーを取り消す必要があります。
ポータル ユーザーは次の手順に従って、アプリの API キーをポータルからローテーションできます。
- デベロッパー アカウント プルダウンから [Apps] を選択します。
- リスト内のアプリをクリックします。
- [API Keys] セクションで、[Add Key] をクリックします。
- ダイアログ ボックスで [Confirm] をクリックして操作を確定します。
- 必要に応じて、下記の手順に従って古い API キーを取り消します。
アプリの API キーを取り消す
前のセクションに従って API キーをローテーションしたとき、元の API キーは、ユーザーが使用停止にしない限り引き続き有効になります。古い API キーの認証情報が受け入れられないようにするため、古い API キーを取り消す必要があります。
ポータル ユーザーは次の手順に従って、アプリの API キーをポータルから取り消すことができます。
- デベロッパー アカウント プルダウンから [Apps] を選択します。
- アプリの名前をクリックします。
- [App Details] タブで、
をクリックします。 [Confirm] をクリックして操作を確定します。
キーのステータスが [Revoked] に変わります。
アプリの詳細を編集する
ポータル ユーザーは次の手順に従って、アプリの詳細を編集できます。
- デベロッパー アカウント プルダウンから [Apps] を選択します。
- リスト内のアプリをクリックします。
- [App Details] タブで [Name] フィールドまたは [Description] フィールドを編集します。
- 必要に応じて、アプリ内の API を管理します。
- [Save] をクリックします。
アプリを削除する
ポータル ユーザーは次の手順に従って、ポータルからアプリを削除できます。
- デベロッパー アカウント プルダウンから [Apps] を選択します。
- リスト内のアプリをクリックします。
- [DELETE] をクリックします。
- [Confirm] をクリックして操作を確定します。
アプリが削除され、アプリのリストからなくなります。