API Experience Hub の概要

Anypoint API Experience Hub は API 管理プラットフォームおよびデジタルエクスペリエンスであり、組織はエンタープライズ内外で活気のある API エコシステムを形成できます。 API プロバイダーは開発者コミュニティと共有やプロモートを行い、交流することができます。開発者やパートナーは 1 つの場所から、どこで設計された API であっても見つけて探索し、コンシュームできます。

API Experience Hub は、API Portal の作成や管理を目的とした API コミュニティマネージャーの次世代の進化形です。ポータル管理者は標準のテンプレートを使用して分単位で開発者ポータルを構築し、Anypoint Exchange からどのオーディエンスにも API をパブリッシュできます。Anypoint Platform によって、ポータルのデプロイメント、管理、API およびユーザー管理のオプションが十分に管理されるため、Salesforce に関する知識がなくても使用を開始できます。

API Experience Hub には、次の利点があります。

ポータル管理者​:

  • すばやく簡単にポータルをセットアップできる

  • API や設定バージョンの表示をオンボーディングできる

  • ユーザー、およびゲストユーザーからのアクセス権の要求を管理できる

  • プレビューしてポータルで反復処理を行うことができる

  • Salesforce エクスペリエンスビルダーを使用して高度なカスタマイズを実行できる

  • Chatter フィード追跡を有効にしてポータルコミュニティと交流できる

  • Google アナリティクスを使用して、コンシューマーが API とポータルをどのように使用しているかについて貴重なインサイトを得ることができる

開発者​:

  • セルフサービス環境を使用して API を検出してアプリケーションを構築できる

  • クライアントアプリケーションを登録するために API インスタンスへのアクセス権を要求できる

  • 対話型の API ドキュメントを使用して API の使用法と統合方法を理解できる

  • カスタマイズ済みの接続されたハブを使用して API を操作できる

  • ポータルコミュニティのメンバーとコラボレーションできる

API Experience Hub 製品スポットライト動画を視聴して概要を確認できる。

ポータルを作成する手順

管理者は、次の手順でカスタムポータルを作成できます。

  1. Salesforce インスタンスに接続します。

    インスタンスとしては新規または既存の Salesforce 組織を使用できます。接続するには、環境種別を指定してカスタム Salesforce ドメインを入力 (ある場合) し、権限を許可してアカウントを確認します。

  2. API Portal をセットアップします。

    Salesforce に接続したら、ポータルのセットアップ方法を選択し、ロゴ、フォント、配色などを使用してポータルの標準のページをスタイル設定します。

  3. ポータルを管理します。

    Exchange から API を追加して API バージョンの表示を設定することで API を管理します。ゲストユーザーからのアクセス権の要求を承認することでユーザーを管理します。

  4. ポータルをパブリッシュします。

    ポータルをパブリッシュしてコミュニティが使用できるようにします。

ポータルページ

各 API Experience Hub ポータルにはホームページ、API ページ、API の詳細ページが含まれます。ポータル管理者は組織のニーズに合わせて各ページをカスタマイズできます。詳細は、API Portal のセットアップを参照してください。

次のサンプルポータルにはホームページが表示されています。

ホームページ

ポータルには次のテンプレートページが含まれます。

  • ホーム

    ホームページにはバナー画像、API Portal タイトル、API Carousel (API カルーセル)、タイプ別の API へのナビゲーションが含まれており、API Portal のランディングページとなります。API Carousel (API カルーセル) では、API コンシューマーは最近ポータルに追加された API をプレビューできます。各カードには API 名、アイコン、タイプ、説明が含まれます。選択すると、開発者は API に関するすべての情報を [API Details (API 詳細)] ページで参照できます。

  • APIs (API)

    API ページには、ポータルのすべての API のカタログが含まれます。開発者はカタログを検索して絞り込むことができます。選択すると、カタログの各カードに [API Details (API 詳細)] ページが表示されます。

  • API Details (API 詳細)

    [API Details (API 詳細)] ページの上部には、名前、説明、タイプ、バージョン、ライフサイクル状態、API の連絡先のメールアドレスなど、API に関するメタデータが表示されます。詳細ページの下部には、概要と API ドキュメントが含まれます。API 概要パネルでは、Anypoint Exchange の API の管理者が作成した概要ページが反映されます。API ドキュメントパネルには、開発者が API ドキュメントを読んで API テストするための対話型のコンソールが含まれます。開発者は、API 仕様で定義された概要、メソッド、エンドポイント、認証の各セクションを読むことができます。

製品の統合

API Experience Hub は、次の製品と統合されています。

  • Anypoint Exchange

    Exchange は、再利用可能なアセット (API、ポリシー、API 仕様フラグメント、API グループ、テンプレート、サンプル、カスタムアセット、コネクタなどのインテグレーションアセット) のカタログです。API Experience Hub 内で、ポータル管理者は Exchange から API をインポートすることでポータルを選定できます。詳細は、 「Anypoint Exchange」​を参照してください。

  • Salesforce Experience Cloud

    API Experience Hub は Salesforce Experience Cloud を活用しており、開発者オーディエンスにカスタマイズとブランド設定の機能が提供されます。詳細は、​「エクスペリエンスビルダーを使用したポータルのカスタマイズ」​を参照してください。

サポートされるブラウザー

サポートされるブラウザーについては、次のトピックを参照してください。