このページの内容は Apigee と Apigee ハイブリッドに該当します。
Apigee Edge のドキュメントを表示します。
すぐに使用できるデベロッパー ポータルでは、ポータル ユーザーがユーザー アカウントの作成、ログイン、API を使用するアプリの管理を行うことができます。
以下のセクションでは、ポータル ユーザーによるポータルの操作方法について説明します。
ポータルへのログイン
以下のセクションでは、ポータル ユーザーがユーザー認証情報（組み込み ID プロバイダ）または SAML（ベータ版）を使用して統合ポータルにログインする方法について説明します。
組み込み ID プロバイダと SAML ID プロバイダの両方を有効にした場合は、ポータル ユーザーが好みのログイン方法を選択できます。
ユーザー認証情報を使用したポータルへのログイン（組み込み ID プロバイダ）
組み込み ID プロバイダが有効な場合、ポータル ユーザーはユーザー認証情報（ユーザー名とパスワード）を使用して統合ポータルにログインできます。次のセクションをご覧ください。
統合ポータルでのユーザー アカウントの作成
組み込み ID プロバイダの場合、ポータル ユーザーが API を使用するには、まず統合ポータルでユーザー アカウントを作成する必要があります。
ポータル ユーザーは次の手順に沿って、統合ポータルでアカウントを作成します。
- ポータルに移動します。
[Sign In] をクリックします。
[Sign In] ページが表示されます。
[Create Account] をクリックします。
[Create your account] ページが表示されます。
![[Create your account] ダイアログ](https://cloud-dot-devsite-v2-prod.appspot.com/static/apigee/docs/api-platform/images/create-account.png?hl=ja)
フォームに入力します。
すべての必須フィールドに値を入力する必要があります。パスワードは 8 文字以上とし、少なくとも数字、英小文字、英大文字、特殊文字をそれぞれ 1 文字以上含める必要があります。
利用規約を確認し、同意します。
[Create account] をクリックします。
- キャプチャ フォームに入力し、[確認] をクリックします（表示されている場合）。
ユーザー アカウントが作成され、確認メールが送信されます。
10 分以内に確認メールのリンクをクリックして、登録プロセスを完了します。
10 分以内にリンクをクリックしなかった場合は、同じ手順をもう一度繰り返してアカウントを作成し、再度確認メールを受け取る必要があります。
統合ポータルにログインします（以下を参照）。
統合ポータルへのログイン
組み込み ID プロバイダの場合、ポータル ユーザーは統合ポータルで登録して承認された後、認証情報（ユーザー名とパスワード）を使用してログインします。
ポータル ユーザーは次の手順に従ってログインします。
- ポータルに移動します。
- [Sign In] をクリックします。
[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 について学習し試用する、または API リファレンス ドキュメントをレンダリングするためのドキュメントをダウンロードすることができます。API リファレンス ドキュメントがどのようにレンダリングされるかについては、API の公開をご覧ください。
デベロッパー チームを使用してアプリの責任を共有する（ベータ版）
ポータル ユーザーは、デベロッパー チームを使用してアプリの責任を他のポータル ユーザーと共有できます。以下のセクションで、デベロッパー チームの作成方法と管理方法について説明します。
デベロッパー チームのロールについて
次の表に、デベロッパー チームのメンバーに割り当てることができる役割をまとめます。
| 役割 | 説明 |
|---|---|
| App Admin |
|
| Owner | デベロッパー チームのメンバー、デベロッパー チームの詳細、アプリに対する完全な読み取りおよび書き込み権限。 |
| Viewer | デベロッパー チームのメンバー、デベロッパー チームの詳細、アプリに対する読み取り専用権限。 |
Teams ページを表示する
[Teams] ページには、自身がメンバーであるデベロッパー チームが表示されます。
[Teams] ページにアクセスするには:
- ポータルにログインします。
- ポータルのユーザー アカウント プルダウンから [Teams] を選択します。
[Teams] ページが表示されます。ここでは次のことができます。
- 名前、ロール、メンバーのリスト、チームの作成日を含む、自身がメンバーのデベロッパー チームを表示する
- デベロッパー チームを追加する
- デベロッパー チームの行をクリックして、デベロッパー チームのメンバーとロールを編集する、自身をデベロッパー チームから削除する、またはチームを削除する
デベロッパー チームの追加
デベロッパー チームを追加するには:
- ポータルにログインします。
- ポータルのユーザー アカウント プルダウンから [Teams] を選択します。
- [+ New Team] をクリックします。
- 名前と説明を入力します。
作成するデベロッパー チームにメンバーを追加するには、[+ Add another member] をクリックし、ポータル ユーザーのメールアドレスを入力してそのユーザーのロールを選択します。
同じ手順を繰り返して残りのメンバーを追加します。
デベロッパー チームからメンバーを削除するには、削除するメンバーの横の
をクリックします。[作成] をクリックします。
デベロッパー チームのメンバーとロールを編集する
デベロッパー チームのメンバーとロールを編集するには:
- ポータルにログインします。
- ポータルのユーザー アカウント プルダウンから [Teams] を選択します。
- 自身がオーナーである、編集するデベロッパー チームの行をクリックします。
必要に応じて次のことを行います。
- 名前、説明、メインの連絡先を編集します。
- デベロッパー チームのメンバーを追加または削除します。
- デベロッパー チームのメンバーのロールを更新します。
[Save] をクリックします。
自身をデベロッパー チームから削除する
自身をデベロッパー チームから削除するには:
- ポータルにログインします。
- ポータルのユーザー アカウント プルダウンから [Teams] を選択します。
- 自身を削除するデベロッパー チームの行をクリックします。
- [Leave Team] をクリックします。
デベロッパー チームの削除
デベロッパー チームを削除するには:
- ポータルにログインします。
- ポータルのユーザー アカウント プルダウンから [Teams] を選択します。
- 削除するデベロッパー チームの行をクリックします。
をクリックします。- [Confirm] をクリックして削除を確定します。
アプリの登録
以下のセクションに沿って、デベロッパー アプリとデベロッパー チーム アプリを登録します。
デベロッパー アプリの登録
ポータル ユーザーは次の手順に従って、公開した API を使用するアプリを登録できます。
- ユーザー アカウントのプルダウンから [Apps] を選択します。
- [+ New App] をクリックして新しいアプリを作成します。
- [New App] ダイアログでアプリの名前と説明を入力します。
[API Catalog] セクションで、1 つ以上の API を選択します。
カタログ内の API は、コールバック URL が必要な認証済み API と、公開 API に分類されています。アプリを作成するには、少なくとも 1 つの API を選択する必要があります。
[Authenticated APIs] セクションで API を選択した場合は、コールバック URL を入力します。
詳細については、コールバック URL についてをご覧ください。
[Create] をクリックします。
デベロッパー チーム アプリの登録
デベロッパー チームのメンバーは、次の手順に沿って、公開した API を使用するデベロッパー チームのアプリを登録できます。
手順の詳細について確認するには:
- ポータル ユーザーがチームを追加、管理する方法については、デベロッパー チームを使用してアプリの責任を共有する（ベータ版）をご覧ください。
- API プロバイダがデベロッパー チームを表示、管理する方法については、デベロッパー チームの管理（ベータ版）をご覧ください。
デベロッパー チーム アプリを登録するには:
- ユーザー アカウントのプルダウンから [Teams] を選択します。
- アプリを登録するデベロッパー チームの行をクリックします。
- [+ New App] をクリックして新しいアプリを作成します。
- [New App] ダイアログでアプリの名前と説明を入力します。
[Owner] プルダウン リストからアプリのオーナーを選択します。
デフォルトでは、デベロッパー チームがアプリの所有者になります。必要に応じて、プルダウン メニューから別のデベロッパー チームまたは自身をオーナーとして選択します。
注: ベータ版リリースでは、アプリを作成した後にアプリのオーナー権限を委譲することはできません。
[API Catalog] セクションで、1 つ以上の API を選択します。
カタログ内の API は、コールバック URL が必要な認証済み API と、公開 API に分類されています。アプリを作成するには、少なくとも 1 つの API を選択する必要があります。
[Authenticated APIs] セクションで API を選択した場合は、コールバック URL を入力します。
詳細については、コールバック URL についてをご覧ください。
[Create] をクリックします。
アプリ内での API の管理
API プロデューサーとして API を公開して、ポータル ユーザーが API プロダクトを使用できるようにします。
ポータル ユーザーは、アプリが使用する API を管理します。選択した API はアプリ詳細ページに追加されます。API の中には、自動的に承認されないものがあります。ステータスが [Pending Approval] の場合は、API へのアクセスがリクエストされているものの、まだ承認されていないことを示します。
ポータル ユーザーは次の手順に従って、ポータルからアプリ内の API を管理できます。
- ユーザー アカウントのプルダウンから [Apps] を選択します。
- リスト内のアプリをクリックします。
- [APIs] セクションで
または 
をクリックして、アプリからの API へのアクセスをそれぞれ有効または無効にします。 - 認証済み API の場合は、必要に応じてコールバック URL を追加または編集します。
アプリでの API キーとシークレットの表示
ポータル ユーザーは次の手順に従って、ポータルからアプリの API キーを管理できます。
- ユーザー アカウントのプルダウンから [Apps] を選択します。
- リスト内のアプリをクリックします。
- [API Keys] セクションに API キーが表示されます。
- API キーのステータスが [Active] であることを確認します。
API キーに承認が必要で、まだ承認されていない場合、ステータスは [Pending Approval] になります。 - [Show secret] をクリックしてシークレットを表示します。
- 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] を選択します。
- アプリの名前をクリックします。
- [API Keys] セクションで、取り消す API キーに関連する [Actions] 列の をクリックします。
[Confirm] をクリックして操作を確定します。
キーのステータスが [Revoked] に更新されます。
アプリの詳細の編集
ポータル ユーザーは次の手順に沿って、アプリの詳細を編集できます。
- ユーザー アカウントのプルダウンから [Apps] を選択します。
- リスト内のアプリをクリックします。
- [App Details] タブで [Name] フィールドまたは [Description] フィールドを編集します。
- 必要に応じて、アプリ内の API を管理します。
- [Save] をクリックします。
アプリの削除
ポータル ユーザーは次の手順に従って、ポータルからアプリを削除できます。
- ユーザー アカウントのプルダウンから [Apps] を選択します。
- リスト内のアプリをクリックします。
- [DELETE] をクリックします。
- [Confirm] をクリックして操作を確定します。
アプリが削除され、アプリのリストからなくなります。