1. Homepage
  2. API コミュニティマネージャー
  3. サイトの操作

  4. API のパブリッシュ

API のパブリッシュ

Anypoint API コミュニティマネージャーコミュニティ管理者は、Anypoint Exchange から自分の Salesforce Experience Cloud サイトに API および API グループを追加してパブリッシュしたり、マイナー/メジャー更新を行ったりできます。

この情報には、Exchange に API と共に保管されている API ドキュメントも含まれます。 API ドキュメントは、Salesforce コンテンツ管理システム (CMS) 保管されている記事とは別に管理されます。API のリリースプロセスには API ドキュメントの更新も含まれ、通常は CMS 記事のリリースプロセスとは別に行われます。 多くの場合、API のリリースプロセスは開発チーム、CMS 記事のリリースプロセスはマーケティングチームが主導します。

Exchange のアセットをサイトに追加する

  1. API コミュニティマネージャーコントロールパネルを開いて ​[API Curator (API キュレーター)]​ を選択します。

    このタブで、各自のサイトのアセットとそのメタデータや表示を管理できます。アセットに該当するものとして API や API グループが挙げられます。

    • [Assets in Your Site (サイトのアセット)]​ には、各自のサイトに追加されているアセットが表示されます。

    • [Assets in Anypoint Exchange (Anypoint Exchange のアセット)]​ には、Exchange 組織に存在するが、各自のサイトにはまだ追加されていないアセットが表示されます。

  2. アセット名の横にある ​[Add (追加)]​ をクリックします。

    または、複数のアセットを選択して、​[Add to your site (サイトに追加)]​ をクリックします。

  3. アセット情報 (名前、アイコン、説明、サイト上の API の表示、各 API のインスタンスの表示) を設定します。

アセット情報を設定する

アセットをサイトに追加すると、アセットの編集ページが開きます。

編集ページを再度開く場合は、アセット名の横にある鉛筆型の編集アイコンをクリックします。

  1. 必要に応じて、​[Asset Name (アセット名)]​、​[Asset Icon (アセットアイコン)]​、​[Description (説明)]​ を編集します。

  2. [Instances visibility (インスタンスの表示)]​ を ​[Only Public (公開のみ)]​ に設定すると、各自のサイトにアセットの公開インスタンスのみが表示されます。​[All instances (すべてのインスタンス)]​ に設定した場合は公開と非公開のインスタンスが表示されます。

  3. 次のセクションの説明に従って API または API グループをプレビューするときに、​[Manage visibility (表示の管理)]​ を使用して、すべてのバージョンの表示を ​[Administrators only (管理者のみ)]​ に設定したり、一部のバージョンの表示を ​[None (なし)]​ に設定したりします。

  4. [Apply (適用)]​ を選択します。

API をプレビューする

  1. API コミュニティマネージャーコントロールパネルで ​[Community Builder (コミュニティビルダー)]​ を選択します。

    コミュニティビルダーに、コミュニティサイトのプレビューと編集オプションが表示されます。

  2. [Preview (プレビュー)]​ を選択します。

  3. コミュニティの各 API または API グループバージョンのカードを表示している API カルーセルまでスクロールします。

新しい API バージョンまたは API グループには​「This is only visible for you (あなたにしか表示されません)」​というメッセージが表示され、表示設定が ​[Administrators only (管理者のみ)]​ であることを示します。この API バージョンまたは API グループプレビューは、コンシューマー開発者には表示されません。

変更が表示されない場合は、​キャッシュを更新​します。

API バージョンを表示する

  1. API コミュニティマネージャーコントロールパネルで、​[API Curator (API キュレーター)]​ をクリックします。

  2. アセット名の横にある編集アイコンをクリックします。

  3. バージョンごとに、API バージョンを公開する場合は ​[Manage visibility (表示の管理)]​ を ​[Everyone (全員)]​ に設定し、ログインしたメンバーにのみ表示する場合は ​[Members only (メンバーのみ)]​ に設定し、そのバージョンを表示しない場合は ​[None (なし)]​ に設定します。

    [None (なし)]​ 以外のオプションを設定して、1 つ以上のバージョンを表示する必要があります。

  4. [Apply (適用)]​ を選択します。

これでコンシューマー開発者が、コミュニティサイトの API カルーセルでこのアセットを確認できます。

[API Curator (API キュレーター)]​ タブの ​[Visibility (表示)]​ 列に、このアセットの最大限に表示されるバージョンの設定が示されます。

API のマイナー更新

テキストの変更など、API 仕様やドキュメントに互換性を破らない変更が必要になった場合、これらの変更はマイナーバージョン変更として行われます (例: バージョン ​3.0.0​ からバージョン ​3.0.1​)。API コミュニティマネージャーは、これらの更新を自動的に、API がパブリッシュされているすべてのコミュニティに直ちにインポートします。API コミュニティマネージャー管理者によるアクションは不要です。

たとえば、API のドキュメントと仕様説明の両方にスペルミスがあったとします。

API 仕様での修正は次の手順で行います。

  1. Design Center​ を開きます。

  2. API プロジェクトを開いてエラーを修正します。

  3. [Publish to Exchange (Exchange へのパブリッシュ)]​ を選択します。

  4. [Publish API specification to Exchange (API 仕様を Exchange にパブリッシュする)]​ ダイアログボックスで、現在の ​[Name (名前)]​、​[Main file (メインファイル)]​、​[API Version (API バージョン)]​ はそのままにしておき、互換性を破らない変更について ​[Asset version (アセットバージョン)]​ を 1 つ増やします。たとえば、​3.0.0​ を ​3.0.1​ に変更します。

  5. [Publish (パブリッシュ)]​ を選択します。

API ドキュメントでの修正は次の手順で行います。

  1. Exchange を開きます。

  2. API を開きます。

  3. [Edit (編集)]​ を選択してエラーを修復します。

  4. [Save As Draft (ドラフトとして保存)]​ を選択します。

  5. [Publish (パブリッシュ)]​ を選択します。

コミュニティサイトでは、修正された情報が直ちにコンシューマー開発者に表示されます。

変更が表示されない場合は、​キャッシュを更新​します。

API のメジャー更新

現在のバージョンとの互換性がない API の新バージョンが作成されたら、API コミュニティマネージャーコミュニティ管理者は、新しいバージョンをサイトでパブリッシュし、古いバージョンを非推奨とマークし、その後に古いバージョンを削除する、それぞれのタイミングと方法をコントロールします。

たとえば、API チームの開発者が API に新しいリソースを追加したとします。

  1. 開発者は、​Design Center​ で API を開いて、仕様にリソースを追加してから ​[Publish to Exchange (Exchange にパブリッシュ)]​ を選択します。

  2. この変更は互換性を破るため、開発者は [Publish API specification to Exchange (Exchange に API 仕様をパブリッシュ)] の ​[API version (API バージョン)]​ 情報を変更します。

    たとえば、​[API version (API バージョン)]​ が ​v3​ であれば、​v4​ に変更します。​[Asset version (アセットバージョン)]​ が ​3.0.1​ であれば、​4.0.0​ に変更します。​[Name (名前)]​ と ​[Main file (メインファイル)]​ は変更しません。

  3. 開発者は ​[Publish (パブリッシュ)]​ を選択します。

    以前の API バージョンは、パブリッシュされているすべてのコミュニティにそのまま残ります。

API コミュニティマネージャーコミュニティ管理者は、変更内容を確認してパブリッシュする必要があります。

  1. API コミュニティマネージャーコントロールパネルで、​[API Curator (API キュレーター)]​ を選択します。

    API は引き続き ​[Assets in Your Sit (サイトのアセット)]​ に表示されます。新しいバージョンの表示は ​[None (なし)]​ になります。

  2. API 名の横にある編集アイコンをクリックします。

  3. 表示を ​[Administrators only (管理者のみ)]​ に変更します。

  4. API をプレビューします。

  5. API コミュニティマネージャーコントロールパネルで、​[API Curator (API キュレーター)]​ を選択します。

  6. API 名の横にある編集アイコンをクリックします。

  7. 新しい API バージョンを公開する場合は表示を ​[Administrators only (管理者のみ)]​ から ​[Everyone (全員)]​ に、ログインしたメンバーにのみ表示する場合は ​[Members only (メンバーのみ)]​ に、そのバージョンを表示しない場合は ​[None (なし)]​ に変更します。

    表示が ​[Everyone (全員)]​ または ​[Members only (メンバーのみ)]​ である場合、コンシューマー開発者は、新しい API バージョンをコミュニティサイトの API カルーセルで見られるようになります。

変更が表示されない場合は、​キャッシュを更新​します。

API および API グループの検索

API コミュニティマネージャーコントロールパネルの ​[API Curator (API キュレーター)]​ タブにある ​[Assets in Your Site (サイトのアセット)]​ タブに、検索条件アイコンと検索バーが表示されます。検索条件アイコンをクリックすると、アセットをアセットタイプ、表示、カテゴリ別に絞り込むメニューが開きます。

次の絞り込み属性を使用して、検索バーの検索結果を絞り込むことができます。

  • name​

  • version​

  • description​

  • businessGroup​

  • assetType​ (​api​ または ​group​)

絞り込み属性を使用するには、属性名とコロンを入力して、その後に属性の値を入力します。 たとえば、​name:order​ で絞り込むと、名前に「order」が含まれる API (「Order Status API」や「Received Orders」など) のみが返されます。

絞り込み属性なしで入力した検索語は、絞り込まれていない API 項目にのみ適用されます。たとえば、​businessGroup:Sales banking​ と入力すると、[Business Group (ビジネスグループ)] 項目に「Sales」が含まれ、[Business Group (ビジネスグループ)] 以外の任意の項目に「banking」が含まれる API が返されます。

[API Curator (API キュレーター)]​ タブにある ​[Assets in Anypoint Exchange (Anypoint Exchange のアセット)]​ タブには検索バーと、アセットタイプ、カテゴリ、ビジネスグループ、状況の検索条件オプションが表示されます。アセット状況検索条件を使用すると、最近作成または更新されたアセットのみが表示されます。

これらのタブには最大 100 件の結果が表示されます。それ以上の結果が省略されている場合は、結果の後にメッセージが示されます。検索項目を使用して API を絞り込み、関連する API が省略されないようにします。