統合ポータルの構築

このページの内容は Apigee と Apigee ハイブリッドに該当します。

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

Apigee には、API ドキュメントの生成、API へのアクセスの管理、アプリデベロッパーコミュニティの振興に役立つ使いやすい統合ポータルが用意されています。

Apigee のすべてのユーザーは、統合ポータル開発ツールを使用して、Drupal ベースポータル開発の代わりとなる独自のデベロッパーポータルを迅速に構築できます。機能の比較については、デベロッパーポータル機能の比較をご覧ください。

動画: 統合ポータルの構築と公開の概要については、次の短い動画をご覧ください。

主な機能と利点

統合ポータルの主な機能と利点を以下に示します。

機能	利点
ポータルコンテンツの開発	ポータルコンテンツを迅速かつ簡単に開発できます。使いやすいページエディタを使用してページを作成 Markdown と HTML を使用してコンテンツを作成ポータルのナビゲーションメニューを追加
ポータルのデザイン	SCSS スタイルシートと独自のブランディングを使用してポータルのデザインを完全にカスタマイズできます。
API ドキュメント	OpenAPI 仕様に基づいて API リファレンスドキュメントを自動生成します。
セルフサービス登録	公開された API を使用してアプリを構築するデベロッパーのためにセルフサービス登録を提供します。
オーディエンス管理	誰がポータルコンテンツと API にアクセスできるかを制御します。
分析	Google アナリティクスとカスタム分析トラッキングを構成できます。
高度なカスタマイズ	ポータルを次のように高度にカスタマイズできます。ドメインのカスタマイズカスタム登録フィールドの追加スクリプトを使用したポータルの拡張メールの構成

Apigee による統合ポータルのセキュリティ対策

次のテーブルに、統合ポータルの組み込み機能を使用して Apigee がセキュリティに対処する方法を示します。

機能	アドレス
HTTPS と TLS（Transport Layer Security）が必要	暗号化された通信を適用します
Public Suffix List を使用した `apigee.io` ドメイン登録を含む	「スーパー Cookie」を `apigee.io` のサブドメインに設定できないようにします
必須: フォーム入力のサニタイズサイト全体の JavaScript インジェクションを管理者に制限	HTML、SQL、バックエンドインジェクション攻撃から保護します
`x-content-type-options: nosniff` XSS ヘッダーを含める	ブラウザが MIME タイプを推測できないようにします
`x-frame-options: deny` XSS ヘッダーを含める	iFrame へのポータルコンテンツの埋め込みを禁止します
`x-xss-protection: 1` XSS ヘッダーを含める	反射型クロスサイトスクリプティング（XSS）攻撃が検出された場合に、ページの読み込みを禁止します
CSRF トークンを使用する	クロスサイトリクエストフォージェリから保護します
以下を利用します。保存時の Google Cloud データの暗号化 Google ユーザーデータと保持ポリシーログとデバッグのデータ保持（6 週間）	お客様のデータ保護

統合ポータルと Apigee とのやり取り

デベロッパーポータルで使用される情報のほとんどは Apigee に保存されます。ポータルは Apigee のクライアントとして機能します。デベロッパーポータルでは必要に応じて HTTP リクエストまたは HTTPS REST リクエストを送信し、情報を Apigee から取得するか、Apigee に送信します。たとえば、ポータルユーザーが新しいアプリをポータルに登録すると、ポータルから Apigee にリクエストが送信され、アプリに関する情報が保存されます。

以降のセクションで、詳しく説明します。

アプリ登録と API キーの保存場所

ポータルユーザーが統合ポータルでアプリ登録プロセスを完了すると、アプリに関する情報（アプリ名やアプリに関連付けられた API プロダクトなど）がポータルから Apigee に送信されます。アプリが正常に登録されると、単一の API キーが Apigee からポータルに返されます。ポータルユーザーはこの API キーを使用して、アプリに関連付けられた API プロダクトにアクセスします。

アプリと API キーに関する情報は Apigee にのみ保存されます。ポータルには保存されません。ポータルユーザーがポータルを使用して（たとえば [My Apps] ページを通じて）アプリに関する情報を表示しようとすると、ポータルは API キーを使って Apigee にリクエストを発行し、該当する情報にアクセスします。

同様に、ポータルユーザーがアプリの追加、削除、変更を行うと、その変更がポータルから Apigee に送信され、保存されます。

アプリと API キーに関するすべての情報は Apigee に保存されるため、Apigee 管理者は Apigee UI または管理 API を使用してその情報を変更できます。たとえば、管理者は次の操作を行えます。

デベロッパーアプリを追加、削除、変更する
デベロッパーアプリの API キーの承認または取り消しを行う

詳細については、アプリ登録を使用した API へのアクセスの管理をご覧ください。

アプリのデベロッパーアカウント情報の保存場所

デベロッパーアカウント情報は、次のように Apigee に保存されます。

組み込み ID プロバイダを使用すると、ポータルユーザーがアカウントを作成する際に、その情報が ID プロバイダに保存され、[Users] ページに表示されます。
SAML ID プロバイダを使用すると、ポータルユーザーがポータルにログインする際に、その情報のシャドウレコードが ID プロバイダに保存され、[Users] ページに表示されます。
ポータルユーザーがデベロッパーアプリを登録すると、ユーザーアカウント情報が Apigee と同期され、[Developers] ページの Apigee で使用できるようになります。

次のユーザーアカウント情報は Apigee に保存されます。

氏名
メールアドレス
ユーザー名
ポータルのアカウントステータス（アクティブまたは非アクティブ）
ポータルのロール（認証済みユーザー、管理者、その他）
ロールベースのアクセス許可
ポータルユーザーが所属するチーム（チーム機能のベータ版リリースに登録済みの場合）

Apigee ではデベロッパーを識別する主キーとしてメールアドレスが使用されるため、各メールアドレスは一意である必要があります。この主キーから、Apigee はデベロッパーが所属する組織ごとに一意のデベロッパー ID を生成します。

詳細については、アプリデベロッパーを登録するをご覧ください。

デベロッパーチーム情報の保存場所（ベータ版）

ポータルユーザーによってポータルでデベロッパーチームが作成されると、次のデベロッパーチーム情報が Apigee に保存されます。

デベロッパーチームの名前と説明
デベロッパーチームのメンバーと各自のロール
デベロッパーチームが割り当てられているアプリ
デベロッパーチームに割り当てられているオーディエンス
デベロッパーチームが作成された時刻

デベロッパーチームに対して一意のメールアドレスが自動生成され、そのメールアドレスがデベロッパーチームを識別するために Apigee によって使用される主キーとして機能します。

詳細については、デベロッパーチーム（ベータ版）を使用してアプリの責任を共有するとデベロッパーチームの管理をご覧ください。

サンプルポータルについて

新しいポータルを作成すると、ポータル開発の出発点として使用するスターターページのセットが提供されます。これらのスターターページにはデモコンテンツが含まれており、それを基にテキストや画像を置き換えて独自のポータルを開発できます。サンプルポータルのテーマでは、マテリアルデザインテーマと SCSS が使用されています。

サンプルポータルのホームページを次に示します。

サンプルポータルで提供されているスターターページは次のとおりです。

ページ	説明
ホーム	掲載されている API について説明するポータルホームページ。これがポータルのデフォルトホームページ（index.html）となります。Angular Material コンポーネントを追加するで説明されている Angular Material コンポーネントの実例を示します。
使ってみる	サンプルのコンテンツページ。チュートリアルの手順を行うことで、このページを編集して上部ナビゲーションに追加する方法を学ぶことができます。
API	使用可能な API のリスト。インタラクティブな API リファレンスドキュメントを生成すると、そのコンテンツへのリンクがこのページに自動的に追加されます。注: このページの内容は、ポータルに公開する API に基づいて自動生成されます。このページの内容を直接編集することはできません。このページはポータルのページのリストには表示されません。ポータルテーマエディタを使用してこのページのスタイルを変更することは可能です。
マイアプリ	承認されたユーザーの登録済みアプリのリスト。ポータルユーザーによるポータルの操作をご覧ください。注: このページの内容は、ユーザーの登録アプリに基づいて自動生成されます。このページの内容を直接編集することはできません。このページはポータルのページのリストには表示されません。テーマエディタを使用してこのページのスタイルを変更することは可能です。
ログイン	登録ユーザーのログインページ。新規ユーザーは、このペーの [Sign In] をクリックして登録できます。ポータルユーザーによるポータルの操作をご覧ください。注: [Sign In] ページはポータルに自動的に含まれます。[Sign In] ページのロゴをカスタマイズし、[Create Account] ページにカスタム登録フィールドを追加できます。このページの内容を直接編集することはできません。このページはポータルのページのリストには表示されません。"
利用規約	サンプルの利用規約ページ。