API プロバイダとして、バックエンド サービスへのアクセスを提供する一連の API を開発しました。次に、デベロッパー ポータルを作成して、アプリ デベロッパーが次のことをできるようにします。
- データとサービスの詳細を理解する
- 包括的なドキュメント（サンプル ユースケース、チュートリアル、リファレンス ドキュメントなど）を読み、API の使用方法を学ぶ
- API を使用するアプリを構築するため、セルフサービス プロセスを使用して登録する
デベロッパー ポータル ソリューションの概要
Apigee では、簡単なターンキー ソリューションから、完全にカスタマイズ可能かつ拡張可能なソリューションまで、さまざまなデベロッパー ポータル ソリューションがサポートされています。これらのソリューションを次の表に示します。ソリューションを選択する際には、ポータルの実装に必要な時間および知識と、カスタマイズの要件のバランスをとる必要があります。
| ソリューション | 特長 | Apigee でホストされているか？ | サポート （ライセンス サブスクリプションが必要です） |
|---|---|---|---|
| Apigee 統合ポータル | シンプルなセルフサービス ポータル開発。 （Apigee Edge Public Cloud のお客様のみ） |
○ | Apigee の年中無休 24 時間体制のサポート |
| Drupal 7 ポータル | Drupal 7 を使用した完全にカスタマイズ可能なポータル開発。Apigee Edge モジュールを使用した Apigee との統合。 | × | Apigee プラットフォーム API 専用の Apigee の年中無休 24 時間体制のサポート |
| Drupal 8 ポータル | オープンソースの Drupal 8 プロジェクトを使用した完全にカスタマイズ可能なポータル開発。Apigee Edge モジュールを使用した Apigee との統合。 | × | Apigee の年中無休 24 時間体制の障害対応サポート |
| カスタム ポータル | Apigee プラットフォーム API を使用した完全にカスタマイズ可能な独自開発ポータル開発。 | × | Apigee プラットフォーム API 専用の Apigee の年中無休 24 時間体制のサポート |
デベロッパー ポータル ソリューションを選択する
選択するデベロッパー ポータル ソリューションを決定するときには、次のデシジョン ツリーを利用し、またデベロッパー ポータル機能の比較をご覧ください。
Apigee Edge for Public Cloud をご利用の場合は、ポータル開発の一般的な用途（標準的な登録やアプリ作成フローなど）や、単なる機能変更にとどまらない、より高度な開発に対応するには、Apigee 統合ポータルの構築を検討してください。
現時点では、Apigee Edge for Private Cloud で収益化を図るお客様は Drupal ベースのポータルのみを利用できます。
デベロッパー ポータルの機能の比較
次の表に、Apigee 統合ポータルと Drupal ベースのデベロッパー ポータルの機能の比較を示します。
| 機能 | 統合ポータル | Drupal |
|---|---|---|
| Markdown を使用したポータル コンテンツの開発 |
|
|
| HTML を使用したポータル コンテンツ開発 |
|
|
| OpenAPI 仕様からレンダリングされた API リファレンス ドキュメント |
|
|
| OpenAPI 仕様バージョン 3 のサポート |
|
|
| API リファレンスからのライブ リクエストの送信 |
|
|
| カスタムテーマ |
|
|
| カスタム メニュー |
|
|
| Google アナリティクスなどの第三者タグ |
|
|
| カスタム JavaScript コード |
|
|
| カスタム ドメイン名 |
|
|
| HTTPS が有効 |
|
|
| アカウント作成に関する利用規約 |
|
|
| モバイル デバイスのディスプレイの最適化 |
|
|
| カスタム スクリプトとスクリプトタグの統合 |
|
|
| SMTP 構成 |
|
|
| メール テンプレートの構成 |
|
|
| CAPTCHA（スパム対策） |
|
|
| デベロッパー アカウントと一般ユーザー向けアカウントの役割と権限 |
|
|
| フェデレーション ログイン |
|
|
| コンテンツ管理 API | Drupal 経由 | |
| 収益化 | 準備中 |
|
| 検索構成 | * |
|
| ブログとフォーラム | ** |
|
| コンテンツ作成用ページ テンプレート |
|
|
| ポータルでのアプリ解析 |
|
|
| ルールベースのイベント管理 |
|
|
| アドオン モジュールで拡張可能 |
|
|
| カスタム アプリ登録フロー |
|
|
| カスタム デベロッパー登録フロー |
|
|
| ポータルログ |
|
|
| リンク チェッカー |
|
|
| Microsoft Internet Explorer と Microsoft Edge のサポート | Microsoft Edge のみ |
|
| Apigee のサポート | 上の表を参照 | 上の表を参照 |
統合ポータルを構築する
Apigee Edge for Public Cloud のお客様は、Edge UI で軽量のデベロッパー ポータルを簡単に作成できます。https://apigee.com/edge に移動してログインし、Edge UI のサイド ナビゲーション バーで [Publish] > [Portals] と選択します。詳細については、統合ポータルを構築するをご覧ください。
次の図は、統合ポータルのランディング ページです。
Drupal ベースのポータルを構築する
Drupal ポータル開発ツールを使用すると、自由にカスタマイズできるデベロッパー ポータルを構築できます。Drupal には、豊富な機能と Drupal のすべての CMS 機能の他に、Apigee が開発した Drupal モジュールも用意されています。しかし、Drupal ベースのポータルを実装するには、多くの時間と労力が必要です。
Apigee Edge では、次の Drupal バージョンがサポートされます。
| バージョン | 説明 |
|---|---|
| Drupal 8 | 信頼性の高いエンタープライズ レベルのコンテンツ管理システム（CMS）を提供するオープンソース ソフトウェアです。Drupal 8 はオープンソースのため、Drupal 8 ポータル開発フレームワークを拡張し、機能強化できます。また、Drupal コミュニティで提供されているノウハウも活用できます。詳細については、Drupal 8 を使用したポータルの構築をご覧ください。 |
| Drupal 7 | 信頼性の高いエンタープライズ レベルのコンテンツ管理システム（CMS）を提供するソフトウェアですが、オープンソースではありません。有料アカウントのお客様が依頼された場合にのみ利用可能です。詳細については、Drupal 7 を使用したポータルの構築をご覧ください。ポータル開発に Drupal 7 を使う場合は、Apigee サポートにお問い合わせください。 |
Apigee Edge API を使ってカスタム ポータルを構築する
完全にカスタマイズした独自のポータルを作成するときに利用できる Apigee Edge API を次の表にまとめます。関連ページ
| カテゴリ | Apigee API | 説明 |
| 分析 | Stats | API で分析を表示します。 |
| API キー | Developer App Keys | アプリでの API の使用を認可するために使われる API キーを管理します。 |
| API プロダクト | API Products | デベロッパー ポータルに公開した API プロダクトを管理します。 |
| アプリケーション | Apps | デベロッパーが API を使うために登録したアプリケーションを管理します。 |
| デベロッパー | Developers | デベロッパー ポータルに登録したデベロッパーを管理します。 |
| 収益化 | Monetization | API を収益化します。 |
PHP 用 Apigee Edge クライアント ライブラリを使用してポータル クライアント統合を簡素化します。この SDK により、前の表で説明した Apigee API を使用する PHP モジュールを簡単に作成できるようになります。PHP 用 Apigee API クライアント ライブラリの詳細については、以下をご覧ください。