Send Docs Feedback

Note: Most user interface tasks can be performed in Edge Classic or the New Edge experience. For an overview, getting started topics, and release notes specific to the New Edge experience, see the docs.

デベロッパポータルとは?

The Apigee New Edge experience provides a simplified portal content development solution using Markdown. For a comparison of features between the New Edge experience and the Classic Developer portal (Drupal-based), see Feature comparison of the portal development tools.

ソーシャル公開機能を持つデベロッパポータルが、デベロッパコミュニティとのコミュニケーションにますます使われるようになっています。たとえば、API ドキュメント、使用条件などの静的なコンテンツや、ブログやフォーラムなどの動的なコミュニティの投稿コンテンツのやり取りに利用されます。 

API の公開、API に関するデベロッパトレーニング、デベロッパのサインアップ、デベロッパによるアプリ登録のために、API プロバイダには、これらに対応した機能が必要になります。実際に動的コミュニティを構築する場合、デベロッパに対する API の公開は、最初の一歩に過ぎません。これ以降、デベロッパコミュニティには、フィードバックの提供、サポートや機能のリクエスト作成、他のデベロッパがアクセスできる独自コンテンツの送信など、さまざまな機能が必要になります。

これらのすべてのサービスを開発コミュニティに提供するため、Apigee Edge は、カスタマイズされた独自の Web サイトを構築、公開できる Developer Services ポータルを提供しています。Edge のすべてのお客様は、クラウドまたはオンプレミスで独自のデベロッパポータルを作成できます。

次のビデオでは、Apigee Developer Services ポータルを紹介しています。

次の図に、デフォルトのデベロッパポータルのホームページを示します。

デベロッパポータルは、基本的に、オープンソース Drupal (http://www.drupal.org) プロジェクトに基づく、コンテンツ管理システム (CMS) です。Drupal は、モジュール形式で機能のコアセットを提供しており、Web サイトのコンテンツ作成に加えて、管理も簡単に実行できます。

デベロッパポータルでは、デフォルトのままで、API ドキュメントの作成、ブログのサポート、スレッド化されたフォーラムなどを始められます。またデベロッパポータルをカスタマイズして、特定の要件に対応することも可能です。カスタマイズでは、ポータルの外観やデベロッパがポータルを操作する方法を変更できます。

ほとんどのカスタマイズは、Drupal メニューを使用して実行します。管理者特権を持つユーザーとしてポータルにログインすると、Drupal メニューがすべてのポータルページの上部に表示されます。

管理機能では、ポータルへのアクセス権をデベロッパが要求する手順、API にアクセスするアプリをデベロッパが登録する方法、特定のロールと API に関連する権限をデベロッパに割り当てる方法、API へのデベロッパのアクセス権を取り消すタイミングなどを管理します。

またデベロッパポータルを使用して、マネタイズの構成と管理を行います。マネタイズを行うと、デベロッパは、デベロッパポータルを通じて「Billing & Reports」、「Catalog & Plans」、およびマネタイズ固有の設定に自らアクセスできるようになります。

ポータルユーザーのタイプ

次の図に 2 種類のポータルユーザーを示します。

  • デベロッパは、API を使用してアプリを構築するユーザーのコミュニティを形成します。API コンソールまたは SmartDocs を使用した API の学習、ポータルでのアカウント登録、API を使用するアプリの登録、デベロッパコミュニティとの情報交換、アプリの使用状況についてダッシュボードで統計情報を確認するなど、アプリのデベロッパは、これらの操作をポータルで実行します。
  • API チームとは、ポータルコンテンツを作成する API プロバイダのことです。このチームは、アプリデベロッパが API を使用できるようにします。また、API ドキュメントを提供したり、アプリ登録、API キー取得のメカニズムをデベロッパに提供したりします。API チームは、次のようなデベロッパポータルの基本的な構成を行います。
    • API キーの自動リクエストまたは手動リクエストの構成
    • API ドキュメント、フォーラム、ブログの保守。およびすべての変更の任意のリビジョン管理
    • リアルタイムの API 呼び出しトレース機能の追加 (Apigee の Console To-Go を使用して、ポータル内から)
    • ユーザーコメントの処理とフォーラムのモデレート
    • ポータル上で機能へのアクセスを制御する Role Based Access Control (RBAC) の強制。例えば、管理者は特定の制御を有効にして、フォーラムの投稿作成やテストコンソールの使用を登録ユーザーに許可することができます。
    • ユーザーの作成と承認のために管理者とデベロッパの両方に送信するメール通知のカスタマイズ
    • 「contact us」ページなど、Web フォームのカスタマイズ

この図には、ポータルユーザーの 3 番目のタイプ、API 製品マネージャは示されていません。次の操作を含めて、API 製品マネージャは、API チームがポータルを構築する方法を定義する責任を負っています。

  • API を製品 (product) にパッケージ化する方法の定義
  • アプリ承認ルールの定義
  • API 製品の価格と課金プランの定義 (ポータルでマネタイズを有効にしている場合)。マネタイズの詳細については、「Understand monetization」を参照してください。

デベロッパポータルのカスタマイズ

API プロバイダは、デベロッパポータルをカスタマイズして API 用に最適化する方法、API の使用について必要な情報をデベロッパコミュニティに提供する方法を検討します。カスタムポータルには、次のようにいくつかの考慮事項があります。

  • API への簡単なアクセス
  • 操作方法ガイド、リファレンスドキュメントなどのドキュメント
  • ブログやディスカッションフォーラムなど、コミュニティ投稿型のコンテンツ
  • サンプルコード
  • 新しいデベロッパ、アプリ、API を短時間で承認できる簡単なサインアッププロセス
  • 管理された権限と資格情報
  • 階層化されたアクセス制御
  • 組織 (organization) にふさわしい外観

ポータルは、基本的な構成で定義済みの状態で提供されます。例えば、デフォルトのままのポータルは、だれでもデベロッパとして登録できる構成になっていますが、デベロッパがポータルにログインするには、管理者が各登録を承認する必要があります。登録の承認後、デベロッパはアプリを登録して API キーを要求し、ポータルを使用して API リソースにアクセスできます。

デフォルトの登録プロセスの手順は次のとおりです。

  1. デベロッパは、デベロッパポータルを通じて登録します。レスポンスでポータルは、アカウント承認のためのメールを管理者に送信します。
  2. 管理者がアカウントを承認し、メールがデベロッパに送信されて、デベロッパはログイン可能になったことを通知されます。
  3. デベロッパはアプリを登録して、アプリで使用する API 製品を選択します。レスポンスでポータルは、一意の API キーをアプリに割り当てます。
  4. デベロッパは、API へのリクエストを作成するときにこの API キーを渡します。

このデフォルトの操作環境は、詳細にカスタマイズできます。例えば、登録後に新しいデベロッパが自動的に承認され、ログインされるように、デフォルトの登録/承認スキームを上書きできます。また初回ログイン時に、あらかじめ使用条件に同意するようにデベロッパに要求することも可能です。

またデベロッパポータルで使用を許可するコンテンツも詳細に制御できます。デフォルトのデベロッパポータルには、API ドキュメント、ブログの投稿、フォーラムディスカッションなど、サンプルコンテンツが表示されます。独自のコンテンツを提供して、各コンテンツタイプの外観をカスタマイズできます。

詳細については、「外観のカスタマイズ」を参照してください。

デベロッパポータルの管理

デベロッパは、API へのアクセスと使用にデベロッパポータルを使用します。管理者は、次のようなアカウント管理作業を実行します。

  • 登録フィールド、組み込みの Captcha、自動または手動の承認など、デベロッパ登録プロセスのカスタマイズ
  • デベロッパの追加または承認。デフォルトでは、すべてのデベロッパはデベロッパポータルを通じて登録できますが、管理者が Dev Portal ユーザーインターフェイスを通じて承認する必要があります。また管理者はポータルでデベロッパを直接作成できます。この場合、ポータルは、アカウントが作成されたデベロッパにメールを自動的に送信します。
  • デベロッパのアカウントの変更。例えば、管理者はユーザーのアカウントステータスを active から blocked に変更したり、会社名など、デベロッパのプロファイル情報を変更したりできます。
  • デベロッパの削除。管理者はデベロッパのアカウントを無効にしたり削除したりできます。
  • ロールと権限の割り当て。管理者は特定のロールをデベロッパアカウントに割り当てることができます。書籍またはその他のコンテンツを作成する権限など、ロールはさまざまな権限と関連付けられています。またロールと関連付けられた権限を変更したり新しいロールを作成したりできます。

詳細については、「ユーザーアカウントの追加と管理」を参照してください。

API Console To-Go の追加

多くのポータルには API Console To-Go が組み込まれています。このツールは Apigee が提供している GUI であり、デベロッパはコードを記述することなく、このツールを使用して API の閲覧とテストを実行できます。コンソールには、ポイントアンドクリック式のインターフェイスが備わっており、デベロッパのために、API へのリクエストの送信、リクエストおよびレスポンスオブジェクトの表示が簡単になっています。またドキュメントが表示されるため、デベロッパは簡単に API の使い方を確認することができます。

次の図に API Console To-Go を示します。

デベロッパポータルとは別に Console To-Go を作成して構成します。作成したら、Console To-Go とポータルを統合したり、スタンドアロンユーティリティとして使用したりできます。

詳細については、「API コンソールとは?」を参照してください。

デベロッパポータル機能の概要

次の表に、デベロッパポータルの機能について概要を示します。

機能 詳細
ブラウザのサポート

Supported software」を参照してください。

ユーザーの登録

  • 新しいデベロッパアカウントの手動または自動での承認
  • OpenID の統合
  • Twitter、Google、および GitHub でのシングルサインオン (SSO) のサポート
  • CAPTCHA
  • カスタムフィールド

User management

  • ユーザーの作成と編集
  • Assign roles

ポータルの外観

  • CSS、イメージ、および Drupal モジュールによるカスタマイズ

コンテンツとコミュニティの管理

  • オープンソース (Drupal) ベース
  • テンプレートベースのコンテンツ作成
  • API ドキュメント、ブログ、フォーラム、FAQ のためにデフォルトで使用可能なコンテンツタイプ
  • 自動化リンク (Del.icio.us、Digg、Twitter)
  • コンテンツのリビジョン管理
  • ブログ用のタグ、キーワード、およびアーカイブ
  • Google アナリティクスとの統合
  • コンテンツ用のカスタマイズ可能な自動入力条件
  • 管理者がモデレートするフォーラム投稿およびコメント
  • カスタムロール、サインイン、匿名ユーザーに基づくさまざまなアクセス

権限

  • ロールベースのアクセスルール

API キーの管理

  • 組み込みのアプリ登録
  • 自動または手動での API キー承認のサポート
  • 管理者によるキーの取消が可能

メール

  • SMTP サーバーの指定
  • ポータルがデベロッパにメールを送信するタイミングの構成
  • ポータルで生成されるメールの内容と形式の制御

ブログ

  • ブログ投稿の作成、編集、および公開
  • ブログの作成を特定のユーザータイプに制限するロールベースの権限

フォーラム

  • スレッド化されたデベロッパフォーラムの作成
  • フォーラムカテゴリの追加的な作成 (必要に応じて)
  • ロールベースのモデレート

ドキュメント

  • API のドキュメント作成
  • FAQ
  • チュートリアル

メニュー

  • メニューの外観と内容の制御

検索

  • 組み込みの Apache Solr 検索
  • 特定コンテンツの検索。例えば、フォーラムまたはブログ。
  • Google インデックスの管理

リンクチェッカー

  • 壊れたリンクを調べるページチェック
  • リンクチェックリストの管理

 

Help or comments?