このセクションでは、Drupal 7 ポータル アセットの統合ポータルへの移行を計画して実施する方法について説明します。
ステップ 1: 統合ポータルを作成する
Drupal 7 ポータル アセットを移行する前に、統合ポータルを作成する必要があります。
統合ポータルを作成するには:
- 統合ポータルの管理に必要なポータルロールがあることを確認します。
- 統合ポータルを作成します。
統合ポータルを作成するときに、ポータル開発の出発点として使用するスターター ページのセットを利用できます。このスターター ページにはデモコンテンツが含まれており、それを基にテキストや画像を置き換えて独自のポータルを開発できます。詳細については、サンプル ポータルについてをご覧ください。
ステップ 2: 統合ポータルを構築する
ポータルの構築手順に従って、ポータルを構築します。
少なくとも、次の表に示す手順を行う必要があります。
ステップ | 説明 |
---|---|
ポータル コンテンツを開発する | コンセプトの説明や概要など。 ページを作成して、既存の Drupal 7 ポータルから直接ページ コンテンツをコピーして貼り付けることができます。 |
ナビゲーションを設定する | 既存の構造に合わせて必要なナビゲーションを作成します。 |
テーマをカスタマイズする | 少なくとも、ブランド要件に合わせて次のコンポーネントをカスタマイズします。 |
カスタム スクリプトを追加する | 必要に応じて、カスタム JavaScript コードをポータルに追加します。 |
メールを構成する | メール通知用の SMTP サーバーとメール通知の内容を構成します。 注: 現在、メール通知の構成は Apigee ハイブリッド統合ポータルで行うことはできません。 |
デフォルトの公開設定を管理する | 特定のリソースのデフォルトの公開設定を管理します。 |
コンテンツ セキュリティ ポリシーを構成する | 必要に応じて、ポータルのすべてのページにコンテンツ セキュリティ ポリシー(CSP)を構成し、クロスサイト スクリプティング(XSS)などのコード インジェクション攻撃から保護します。
注: 現在、この機能は Apigee ハイブリッド統合ポータルで使用できません。 |
ステップ 3: ID プロバイダを構成する
次の表に示す認証タイプに応じて、統合ポータルに ID プロバイダを構成します。
認証 | 説明 |
---|---|
組み込み ID プロバイダ(ユーザー名 / パスワード) | 統合ポータルで組み込み ID プロバイダを構成します。 |
SAML を使用したシングル サインオン(SSO) | 統合ポータルで SAML ID プロバイダ(ベータ版)を構成します。
注:
|
デベロッパーがポータルにログインすると、デベロッパー アカウントの管理の説明に沿ってアカウントを管理できます。
ステップ 4: オーディエンスを使用してリソースへのアクセスを制御する
Drupal 7 でロールを使用して、API ドキュメント、API プロダクトの API キー作成などのリソースセットに対するアクセスを制御している場合は、統合ポータルのオーディエンスを使用すると同じ機能を実現できます。
たとえば、オーディエンスを使用すると、統合ポータル上の次のリソースに対するアクセスを制御できます。
- ポータルのページ
- 公開されている API プロダクト
オーディエンスを追加して個々のユーザーとデベロッパー チームの割り当てを管理するには、オーディエンスを管理するをご覧ください。新しいユーザーがアカウントを作成してポータルにログインしたら、オーディエンスの割り当てを管理するで説明しているように、必要に応じて 1 つ以上のオーディエンスに割り当てる必要があります。
移行を簡単にするために、次のことに注意してください。
- 置き換える Drupal のロールに基づいてオーディエンスに名前を付けます。
- デベロッパー チームを使用して、オーディエンス メンバーシップを管理します。デベロッパーは、チームを作成してアプリの責任を共有し、チーム メンバーシップを管理します。
ステップ 5: API を公開する
API を公開し、統合ポータルで SmartDocs を使用して API リファレンス ドキュメントを自動生成するには、API に関連付けられた OpenAPI 仕様にアクセスする必要があります。
Drupal 7 で SmartDocs を自動生成するために OpenAPI 仕様を使用している場合でも、コンテンツは元の OpenAPI 仕様と関連付けられずに内部形式で保存されます。通常、Apigee Edge を使用する API チームは Apigee Edge 仕様ストアに OpenAPI 仕様を保存します。
次に、ポータルに API を公開します。次の準備を行います。
- ドキュメント ソースとして使用する OpenAPI 仕様(仕様ストア、ローカル ディレクトリ、URL)を指定する
- ドキュメントの公開設定を行う(公開、認証ユーザー、選択したオーディエンス)
- 必要に応じて、コールバック URL を構成する
- 必要に応じて、API カタログのディスプレイに画像を追加する
ステップ 6: デベロッパー チームを使用してアプリの責任を共有する
デベロッパーが Drupal 7 でカンパニー アプリを使用してアプリの責任を共有する場合は、統合ポータルでデベロッパー チームを使用することで同じ機能を実現できます。
デベロッパー チームを使用してアプリの責任を共有する(ベータ版)で説明されているように、デベロッパーはアプリの責任を共有するデベロッパー チームを作成し、チームのメンバーを管理します。
デベロッパーのコミュニティでデベロッパー チームについて説明することをおすすめします。デベロッパーは、アプリを移行してデベロッパー チームでアプリの責任を共有し、新しい API キーを使用する必要があります。この作業が完了すれば、Edge API を使用して、カンパニー アプリとそれに関連するアーティファクトをすべて削除できます。
また、会社所有アプリのデベロッパー チームへの移行で説明されているように、カンパニー アプリをデベロッパー チームのアプリに移行することもできます。
ステップ 7: 統合ポータルの起動を準備する
統合ポータルを本番環境で起動する前に、次の表に記載されている手順を行うことを検討してください。
ステップ | 説明 |
ドメインのカスタマイズ | サイトに個性を与えるため、独自のカスタム ドメイン名を提供します。 注: 現在、この機能は Apigee ハイブリッド統合ポータルで使用できません。 |
分析トラッキングの構成 | Google アナリティクスまたは独自のカスタム分析トラッキング サービスを使用して分析トラッキングを構成します。 |
カスタム検索ページの作成 | カスタム検索ページを作成し、Google カスタム検索エンジンを埋め込みます。 |