ドラフト製品の作成

一連の API およびプランを収集して、開発者が利用できるようにする 1 つのオファリングとしてまとめるためのドラフト製品を作成します。 プランには、レート制限の設定が含まれます。レート制限は、プラン全体に適用することも、API 内の個々の操作に対して指定することもできます。 製品およびプランを使用することで、開発者がアクセスできる API およびサブスクリプション条件をより柔軟に制御できます。

開始前に

API を定義します。 詳しくは、 API 定義の作成を参照してください。
ヒント: このタスクで説明されている方法を使用するだけでなく、API を作成する際に製品を作成することもできます。 デベロッパーズ・ツールキットのコマンド・ライン・エディターを使用して API を作成する場合は、製品が自動的に作成されます。 その後、API Designer「製品」ページで新規製品を開くことにより、任意の製品設定を変更できます。

このタスクについて

このタスクは、 API Designer UI アプリケーションを使用するか、ブラウザー・ベースの API Manager UI を使用して実行できます。

製品を初めて作成したときの製品の状況はドラフト です。 ドラフト製品の構成が完了したら、その製品をカタログにステージングして、製品内の API をアプリケーション開発者が使用できるようにすることができます。

手順

製品を作成するには、以下のステップを実行します。

  1. ナビゲーション・ペインで、 API UI ナビゲーション・ペインの「開発」アイコン 「開発」をクリックし、 「製品」 タブを選択し、 追加 > 「製品」をクリックします。
    「製品の追加」 ページが開きます。
  2. 「新規製品」を選択して、 「次へ」をクリックします。
  3. 「情報」 ページで、以下の手順を実行します。
    1. 製品の 「タイトル」「バージョン」 を入力し、オプションで説明を入力します。 「名前」 は自動的に入力されます。
      注: 「名前」 フィールドの値は、 デベロッパーズ・ツールキット CLI コマンドで製品を識別するために使用される単一のストリングです。 「タイトル」 は表示に使用されます。

      ドラフト製品を管理するための CLI コマンドを表示するには、 ツールキット CLI リファレンス資料を参照してください。

    2. 「次へ」をクリックします。
  4. 「API」 ページで、本製品に含める API を選択します。 ステージングには、ゲートウェイ タイプが製品 のゲートウェイ タイプと一致する API、または強制オプションが無効になっている API のみを含めることができます。 Enforced オプションが無効になっている API は、 API Connect ゲートウェイ では管理されません。 ゲートウェイ・タイプがこの製品のゲートウェイ・タイプと一致しない互換性のない API を選択すると、警告メッセージが表示され、互換性のない API の選択がクリアされるまでは変更を保存できません。 ゲートウェイ・タイプの詳細については、 API Connect gateway typesSpecifying gateway type for a ProductSpecifying gateway type for an API definitionを参照してください。
  5. 「次へ」をクリックします。
  6. 「プラン」 ページで、以下の手順を実行します。
    1. オプション: デフォルトのプランのタイトル、説明、またはレート制限の設定を変更します。
    2. オプション: さらにプランを追加するには、 「追加」をクリックし、スクロールダウンして、必要に応じてプラン設定を変更します。
    3. 「次へ」をクリックします。
  7. 製品を作成後に自動的にサンドボックス・カタログに公開するには、 「製品の公開」を選択します。
    注: 公開オプションは、 API Designer UI では使用できません。
  8. 「製品の公開」 を選択した場合は、製品の公開先のゲートウェイ・サービスを選択できます。 デフォルトでは、製品は関連するすべてのゲートウェイ・サービスに公開されます。
  9. 「可視性」セクションで、この製品が表示されるユーザーを指定します。 「公開」を選択して、製品がすべてのユーザーに表示されるようにするか、「認証済み」を選択して、正常に認証されたユーザーが製品を使用できるようにするか、「カスタム」を選択して、製品を表示するコンシューマー組織およびコンシューマー組織グループを指定できます。

    「カスタム」を選択した場合は、「追加する組織を入力」フィールドを使用して、製品内のプランをサブスクライブできるコンシューマー組織およびコンシューマー組織グループを検索します。 コンシューマー組織 およびコンシューマー組織グループを作成および管理する方法については、 コンシューマー組織の管理を参照してください。

    可視性は、カタログ・レベルまたはスペース・レベルでも設定できます。 詳しくは、 カタログでの製品の可視性の構成を参照してください。

  10. 「サブスクライブ可能性」 セクションで、製品内のプランをサブスクライブできるユーザーを指定します。 「認証済み」を選択して、正常に認証されたユーザーが製品内のプランをサブスクライブできるようにしたり、「カスタム」を選択して製品内のプランをサブスクライブできるコンシューマー組織およびコンシューマー組織グループを指定したりできます。
    「カスタム」を選択した場合は、「追加する組織を入力」フィールドを使用して、製品内のプランをサブスクライブできるコンシューマー組織およびコンシューマー組織グループを検索します。 カスタム可視性を選択した場合は、そこで選択したコンシューマー組織およびコンシューマー組織グループのみを、カスタム・サブスクライブ可能性リストに追加できます。 コンシューマー組織 およびコンシューマー組織グループを作成および管理する方法については、 コンシューマー組織の管理を参照してください。
    注: カスタムの可視性またはサブスクライブ可能性を選択した場合、選択可能なコンシューマー組織 およびコンシューマー組織グループ は、接続先の管理サーバーおよびプロバイダー組織のサンドボックス・カタログ内のグループです。 別のカタログまたはスペース内にあるコンシューマー組織 またはグループ を指定する場合は、そのカタログまたはスペースに製品を公開し、そこで可視性またはサブスクライブ可能性を構成します。詳しくは、 製品の可用性の変更を参照してください。

    API Managerのユーザーインターフェイスを使用している場合、接続の詳細は、開いた API Manager URL と、ログインに使用するユーザーIDによって決定されます。 If you are using the APIデザイナー user interface, you provide the management server details and user ID in the login window that opens when you first launch APIデザイナー; see API Designerへのログイン.

    API Designer でオフライン作業を行っている場合は、組織またはグループの正確な名前を入力する必要があります。

    カタログ内のコンシューマー組織について詳しくは、 コンシューマー組織の管理を参照してください。

  11. 「次へ」 をクリックして製品を作成します。
    1. 製品をさらに構成するには、 「製品の編集」をクリックします。
      詳しくは、「 ドラフト製品の編集 」を参照してください。
    2. この時点で製品をこれ以上構成しない場合は、パンくずリストの最初の 「開発」 リンクをクリックして 「開発」 ページに戻ります。その後、すぐに別のタスクに進むことができます。
      後で製品を構成する方法について詳しくは、 ドラフト製品の編集を参照してください。

結果

ドラフト製品を作成し、一連の API およびプランを指定して、1 つのオファリングにまとめました。これで、このオファリングを開発者が利用できるようすることが可能になりました。

次のタスク

製品をカタログにステージングします。 詳しくは、 ドラフト製品のステージングを参照してください。