1. Homepage
  2. API Experience Hub

  3. API Portal のセットアップ

API Portal のセットアップ

Salesforce 組織に接続したら、ポータル管理者はガイド付きセットアップに従い、標準テンプレートを使用してポータルのセットアッププロセス (ポータルの作成やスタイル設定など) を実行できます。

新規ポータルを作成したり、既存のポータルを使用して新規ポータルを作成したり、後でポータルを作成したりできます。新規ポータルを作成するオプションでは、Salesforce 組織から切断された既存のポータルが使用されます。新規ポータルは、既存のポータルのスタイル設定メタデータを使用します。ガイド付きセットアップからこのオプションを選択すると、スタイル設定プロセスを経由することなく、ポータルをすばやくセットアップできます。ポータルごとに設定できる Salesforce 組織は 1 つのみであるため、既存のポータルはその Salesforce 組織の新規ポータルで上書きされます。

ガイド付き設計には、ホームページ、[API Catalog (API カタログ)] ページ、[API Details (API 詳細)] ページの基本的なスタイル設定オプションと、ポータルを視覚化するのに役立つライブプレビューが含まれます。各ページには、ポータル設計プロセスのどの段階にいるかが表示される進行状況バーが含まれます。

API Portal のスタイル設定には次のタスクが含まれます。

  1. ホームページをスタイル設定する

    ホームページは API Portal のランディングページであり、API Carousel (API カルーセル) とも呼ばれます。テンプレートにはロゴの追加、バナー画像、組織のブランディング、バナータイトル、ポータルの説明、フッター設定が含まれます。

  2. API カタログのスタイル設定

    [APIs (API)] ページにはポータルの API のコレクションが含まれ、API Catalog (API カタログ) とも呼ばれます。テンプレートには REST や HTTP など、各 API タイプの色のカスタマイズが含まれます。

  3. [API Details (API 詳細)] ページのスタイル設定

    [API Details (API 詳細)] ページには、API に関する情報が表示されます。テンプレートには名前、API のタイプ、オーナーのメールアドレス、API の説明が含まれます。

API Portal をセットアップする

ポータルの作成方法を選択して、API Portal をセットアップします。

  1. ガイド付きセットアップの ​[Set up API portal (API Portal のセットアップ)]​ ページから、ポータルを作成するオプションを選択します。

    1. 新しいポータルを作成するには、​[Create new portal (新規ポータルを作成)]​ をクリックします。

    2. 既存のポータルのスタイル設定の選択内容を使用して新規ポータルを作成するには、​[Use existing portal (既存のポータルを使用)]​ をクリックし、​[Override and create new portal (上書きして新規ポータルを作成)]​ をクリックします。

    3. 後でポータルを作成するには、​[Set up portal later (後でポータルをセットアップ)]​ をクリックします。

ポータルをスタイル設定する

ガイド付き設計に従って ​[Next (次へ)]​ をクリックして手順を進めます。

ページを更新するか、ガイド付き設計を終了すると、ガイド付きセットアップの進行状況が保持されません。もう一度すべての手順を実行する必要があります。

始める前に

ポータルをスタイル設定する前に、以下が必要です。

  • 会社ロゴの画像

  • ポータルの配色

  • 会社のブランディング用のフォント

  • ポータルのヘッダーとして使用する画像

API Portal のホームページをスタイル設定する

ガイド付き手順に従ってホームページをスタイル設定します。

  1. 会社ロゴを追加するには、画像ファイルを ​[Upload company logo (会社ロゴをアップロード)]​ にドラッグまたはアップロードします。

    サポートされるファイル形式は PNG、JPEG、SVG、GIF です。

  2. バナー画像を追加するには、画像ファイルを ​[Select banner image (バナー画像を選択)]​ にドラッグまたはアップロードします。

    サポートされるファイル形式は PNG、JPEG、SVG、GIF です。

  3. フォントと色を使用して組織をブランド設定するには、​[Customize org branding (組織のブランディングをカスタマイズ)]​ で次の作業を行います。

    • ドロップダウンメニューからフォントのスタイルを選択します。

    • カラーピッカーからバナー画像のフォントの色を選択します。

    • カラーピッカーからページの背景色を選択します。

  4. ポータルバナーのタイトルを追加するには、​[Enter portal banner title (ポータルバナータイトルを入力)]​ テキストボックスにタイトルを入力します。

  5. API Portal の説明を追加するには、​[Enter portal description (ポータルの説明を入力)]​ テキストボックスに説明を入力します。

  6. フッターテキストと URL を追加するには、​[Configure footer (フッターを設定)]​ の対応するテキストボックスにフッターテキストと URL を入力します。

  7. [Next (次へ)]​ をクリックして API カタログをスタイル設定します。

API Catalog (API カタログ) をスタイル設定する

ガイド付き手順に従って API Catalog (API カタログ) をスタイル設定します。

  1. 特定の API の色をカスタマイズするには、​[Customize colors (色をカスタマイズ)]​ の対応する API タイプのカラーピッカーから色を選択します。

  2. API Catalog (API カタログ) のバナータイトルを追加するには、​[Enter API catalog banner title (API カタログのバナータイトルを入力)]​ テキストボックスにタイトルを入力します。

  3. API Catalog (API カタログ) の説明を追加するには、​[Enter API catalog description (API カタログの説明を入力)]​ テキストボックスに説明を入力します。

  4. [Next (次へ)]​ をクリックして [API Details (API 詳細)] ページをスタイル設定します。

[API Details (API 詳細)] をスタイル設定する

ガイド付き手順に従って [API Details (API 詳細)] ページをスタイル設定します。

  1. API オーナーのメールアドレスを表示するには、​[Customize API Information (API の情報をカスタマイズ)]​ から ​[API Contact (API 連絡先)]​ を有効にします。

  2. [API details (API 詳細)] ページに API クライアントアプリケーションを表示するには、​[Customize API Information (API の情報をカスタマイズ)]​ から ​[API Clients (API クライアント)]​ を有効にします。

  3. [API Details (API 詳細)] ページにバナータイトルを追加するには、​[Enter API detail banner Title (API 詳細のバナータイトルを入力)]​ テキストボックスにタイトルを入力します。

  4. [API Details (API 詳細)] ページの説明を追加するには、​[Enter API detail description (API 詳細の説明を入力)]​ テキストボックスに説明を入力します。

  5. ポータルのスタイル設定を完了していない場合は、​[Previous (前へ)]​ をクリックして前のページのスタイリングを変更します。

  6. ポータルのスタイル設定を完了している場合は、​[Save changes (変更を保存)]​ をクリックします。

    スタイルを保存してポータルを作成するプロセスには、数分かかる場合があります。いつでもページから離れることができます。

デフォルト設定

次の設定は、ポータルを作成したときにデフォルトで設定されます。

  • ゲストユーザーのセルフ登録はデフォルトで有効になります。

  • ポータルの状況は有効になります。

    ポータルはパブリッシュするまで公開されません。

次のステップ

これでポータルが作成されたため、​[Manage your portal (ポータルを管理)]​ ページから API をポータルに追加して管理し、ユーザーを管理して、設定情報を表示し、ポータルを切断できるようになりました。

関連情報