IBM® API Connectでカタログを作成および構成する方法。
開始前に
このタスクを実行するには、カタログ作成権限が必要です。
- カタログを作成するユーザーは自動的にカタログの所有者となり、カタログの許可がすべて与えられます。
- ユーザを開発者ポータルで認証するために新しいユーザ・レジストリを構成する場合は、カタログのオンボーディング・セクションも完了させて、レジストリを開発者ポータル・ユーザが使用できるようにする必要があります。 詳しくは、ステップ 10 を参照してください。
- 開発者ポータルのすべてのアカウント (同じサイトの異なるユーザ登録を含む) は、 サイト管理者アカウントを含めて、一意な電子メールアドレスを持っていなければなりません。 例えば、特定の開発者ポータル・サイトに対して 3 つの異なるユーザ登録を構成する場合、電子メール・アドレスは以下のようになります。 alice@acme.com を使用して、ユーザ登録のうちの 1 つだけからサイトにログインできます。 管理者アカウントのデフォルトの E メール・アドレスは、カタログ所有者の E メール・アドレスです。 管理者アカウントと同じ E メール・アドレス (または、カタログ所有者の E メール・アドレスが異なる場合はその E メール・アドレス) を使用してユーザー・アカウント (および関連するコンシューマー組織) を作成できません。 同じメールアドレスでアカウントを作成しようとすると、新しいアカウントは正しく機能せず、ログインしようとすると次のようなエラーメッセージが返されます：A user already exists with this email address.
手順
カタログを作成および構成するには、以下の手順を実行します。
- API Managerにログインし、
Manageをクリックする。
- カタログを作成します。
以下のいずれかの方法でカタログを作成できます。所有者を指定し、以下のようにカタログを構成する。
- クリックします。
- 「カタログ所有者」 フィールドで、カタログの所有者を選択します。
デフォルトでは、あなたがオーナーです。 ただし、プロバイダー組織のメンバーであれば、どのユーザーを指定してもよい。
- ステップ 3 に進み、カタログを構成します。
以下のように、アクティベーション・リンクが記載された招待 E メールを、目的のカタログ所有者に送信します。
- クリックします。
- カタログ所有者の E メール・アドレスを入力して、「招待」をクリックします。
- E メールを受信したら、カタログ所有者はカタログをアクティブ化して構成する必要があります。
- アクティベーションリンクを開き、サインアップフォームに記入し、 API Manager UIにサインインします。
- カタログの管理] をクリックし、サインアップフォームで提供されたカタログ名をクリックし、[ カタログ設定] タブをクリックします。
- ステップ 6 に進み、カタログを構成します。
- カタログの 「タイトル」を入力します。 「名前」は自動的に入力されます。変更することはできません。
注: 「名前」 フィールドの値は、
デベロッパーズ・ツールキット CLI コマンドでカタログを識別するために使用される単一のストリングです。
「タイトル」 は表示に使用されます。タイトルは変更できますが、名前は変更されません。
カタログを管理するCLIコマンドについては、 ツールキットのCLIリファレンス・ドキュメントを参照してください。
- 「作成」をクリックします。
新しいカタログが「管理」ページに表示されます。
- カタログの構成を続行するには、 「管理」 ページでカタログを選択し、 「カタログ設定」 タブをクリックします。
- カタログの一般設定を行うには、「 概要 」をクリックし、以下の手順に進みます。
- プロダクションでカタログを使用するには、 プロダクションモードのスライダーコントロールをオンに設定し、［ 確認］をクリックします。
デフォルトでは、新しいカタログは開発カタログです。
開発カタログでは、すべての公開操作は強制的に行われ、競合があれば自動的に解決されます。 以前に公開した製品バージョンを再公開すると、前のバージョンは警告なしで上書きされます。これにより、テスト中に同じ製品バージョンを繰り返し再公開するなどの操作が可能になります。 スペースが開発カタログで有効になっており、以前に公開した製品バージョンを別のスペースに再公開した場合、その製品バージョンは以前のスペースから削除されます。
ただし、カタログが承認を必要とするように構成されている場合、開発カタログは、ステージングおよび発行アクションの承認を必要とすることに関して、他のカタログと同じように動作します。
注: 実動カタログでは、以下の条件が適用されます。
- 同じ名前とバージョンの製品がカタログ内に既に存在する場合、製品をカタログに公開することはできません。 代わりに、公開のために製品の新規バージョンを作成する必要があります。 製品の新規バージョンの作成 を参照してください。 実動カタログ内でスペースが有効な場合、同じ名前とバージョンの製品をカタログ内の複数のスペースに公開することはできません。
- この新しい製品に 1 つ以上の変更された API が含まれる場合は、製品に含める API の新しいバージョンを作成する必要があります。 製品に変更されたAPIが含まれ、同じ名前とバージョンのAPIが既に公開されている場合、変更は公開されません。
- このカタログをスペースに分割できるようにするには、 「スペース」 スライダー・コントロールを 「オン」 の位置に設定してから、 「確認」をクリックします。
- カタログがデフォルトのステージング・カタログである場合は、 「デフォルト」 スライダー・コントロールを 「オン」 の位置に移動して、 「確認」をクリックします。 選択した場合、カタログに公開した API の呼び出しに、カタログ名を含まない短縮 URL を使用できます。
注: 「デフォルト」 は、1 つのカタログに対してのみ有効にすることができます。 他のカタログがすでにデフォルトカタログとして設定されている場合、まず他のカタログの設定を無効にしなければ、このカタログの設定を有効にすることはできません。
- カタログのゲートウェイ・サービス設定を構成するには、 ゲートウェイ・サービスをクリックし、次の手順に進みます。
注： カタログでスペースが有効になっている場合、カタログ全体ではなくスペースに対してゲートウェイ設定を構成する。
- 「編集」をクリックします。
- このカタログと共に使用するゲートウェイ・サービスを選択します。
- 変更内容を保存するには、 「保存」 をクリックします。
イベント ゲートウェイ サービスが利用できないカタログでは、 Event Endpoint Management から AsynchAPIs を作成またはインポートする UI が無効になります。 カタログで AsynchAPIs、Event Gatewayサービスをカタログに追加する必要があります。
API を製品に追加してからその製品をカタログに公開することで、API を公開します。 製品をカタログに公開するには、カタログが少なくとも1つのゲートウェイ・サービスに割り当てられ、製品内のAPIがゲートウェイ・サービスのエンドポイントで呼び出されるようにする必要があります。 1 つのカタログに複数のゲートウェイ・サービスを割り当てることができ、それらは DataPower® API Gateway と DataPower Gateway (v5 compatible)の混合タイプにすることができます。
製品は、 DataPower API Gateway または DataPower Gateway (v5 compatible)のいずれかのゲートウェイ・タイプ固有です。 デフォルトでは、製品をカタログに公開すると、その製品と同じゲートウェイ・タイプのすべての割り当て済みゲートウェイ・サービスに公開されますが、公開時には、そのタイプの選択されたゲートウェイ・サービスにのみ製品を公開することを選択できます。詳しくは、 ドラフト製品の公開 を参照してください。 製品に含まれるAPIは、指定されたすべてのゲートウェイ・サービスのエンドポイントで呼び出すことができます。
2つ以上のゲートウェイ・サービスを選択した場合、このカタログの
開発者ポータルでアナリティクス・データを利用できるようにするには、ゲートウェイ・サービスがすべて同じアナリティクス・サービスに関連付けられている必要があります。 選択したゲートウェイ・サービスに関連する分析サービスのセットに、2つ以上の異なる分析サービスが含まれている場合、
開発者ポータルには分析データが表示されません。
- 承認を強制する製品ライフサイクルの状態変更を指定するには、以下のステップを実行します。
- カタログ設定ナビゲーションペインでライフサイクル承認をクリックし、 編集をクリックする。
- 必要な状態変更を選択し、完了したら 「保存」 をクリックします。
たとえば、[
発行] を選択し、他のチェック ボックスをクリアしたままにすると、誰かが製品を発行しようとしたときに承認が必要になりますが、その他のライフサイクル状態の変更には承認は必要ありません。
注: カタログ内の製品のライフサイクル状態変更の承認は、デフォルトでは無効になっています。 実施するには、ライフサイクル状態変更を明示的に有効にする必要があります。
- 製品ライフサイクルの変更の起草者自身がその変更を承認できるようにするには、 タスクの自己承認スライダコントロールを On の位置に移動し、[ 確認] をクリックします。
注: 開発カタログでは、製品のライフサイクル変更のオリジネーターは常にそれを承認することができます。 プロダクションカタログでは、カタログ設定「 タスクの自己承認 」が有効になっている場合に限り、製品ライフサイクル変更の起案者自身がそれを承認できる。
- 「保存」をクリックします。
- API Managerの各ロールが持つ権限を設定するには、以下の手順を実行します。
- カタログ設定のナビゲーション・ペインで、 「役割」 をクリックします。
ロールの現在の許可を確認するには、ロールを展開します。
- 作業したいロールの横にあるオプションアイコン（
）をクリックし、「 編集 」をクリックします。
- 必要に応じて、許可のチェック・ボックスを選択するか、クリアします。
ロールがユーザー定義ポリシーを管理できるようにするには、 設定権限で管理を選択します。
特定のライフサイクル状態変更を承認する許可をロールに付与するには、「製品の承認 (Product-Approval)」セクションでその状態変更を選択します。
注: プロバイダー組織レベルで役割に割り当てられている許可を削除することはできません。 ただし、プロバイダー組織レベルで割り当てられていない許可は追加できます。
- ロールをグループにマッピングするには、［ 外部ロールのマッピング］で ［ 外部グループのマッピングを有効にする ］チェックボックスを選択し、各フィールドに必要な情報を入力します。
- 「保存」をクリックします。
- このカタログへの API コンシューマーのオンボーディングを管理するには、以下の手順を実行します。
- カタログ設定のナビゲーション・ペインで 「オンボーディング」 をクリックします。
- このカタログに関連付けられている 開発者ポータル のユーザーの認証に使用するレジストリーを選択するには、 「カタログ・ユーザー・レジストリー」 セクションで 「編集」 をクリックし、必要なレジストリーを選択してから、 「保存」をクリックします。
ユーザ・レジストリの構成方法の詳細については、
企業ユーザ・レジストリを使用した認証を参照してください。
重要セルフサービス・オンボーディングが有効になっている場合や、いずれかのサイトでアカウントの削除が予想される場合は、 API Manager と Developer Portal の間、または Developer Portal サイト間でユーザ登録を共有しないでください。 別々のレジストリーが同じバックエンド認証プロバイダー (例えば、LDAP サーバー) を指している場合でも、それらに対して別々のユーザー・レジストリーを作成する必要があります。 この分離により、 API Managerが同じ要件を必要としなくても、 Developer Portalがカタログ全体で一意の電子メールアドレスを維持できるようになる。 また、ユーザが Developer Portalからアカウントを削除し、 API Managerへのアクセスに影響する問題も回避できる。
- デフォルトのレジストリを設定するには、必要なレジストリを探し、 クリックします。
API コンシューマが Developer Portal にサインアップすると、指定されたレジストリがデフォルトで使用されます。
- APIコンシューマが開発者ポータルへのサインアッププロセスを完了できるようにするには、 セルフサービスオンボーディングを オンに設定します。
このオプションを無効にすると、消費者組織の所有者からの招待がない限り、API利用者はサインアップできない。
- 開発者ポータルへのすべての新しいセルフサービスオンボーディングの承認を必要とするには、 セルフサービスオンボーディングの承認を オンに設定します。
このオプションを有効にすると、API コンシューマが
開発者ポータルにサインアップしようとすると、承認要求が送信されます。 この要求は、関連する
開発者ポータルのカタログの
[タスク] タブに表示され、そこから要求を承認または拒否できます。
セルフサービスのオンボーディング承認は、消費者組織が作成されるたびに尊重されます。 そのため、APIコンシューマが特定のコンシューマ組織で Developer Portalにアクセスすることがすでに承認されている場合でも、同じ Developer Portalで別のコンシューマ組織を作成しようとすると、そのリクエストは承認プロセスを通過することになる。
注: セルフサービス・オンボーディングの承認を有効にするには、以下のタスクも実行する必要があります。
- ユーザーの E メール・アドレスを要求するようにユーザー・レジストリーを構成します。
- 承認のためにユーザーの E メール・アドレスを送信するように OIDC アプリを構成します。
- セルフサービス・オンボーディング・タスクのタイムアウト期間を編集するには、 「セルフサービス・オンボーディング・タスクのタイムアウト」 セクションで 「編集」 をクリックし、必要なタイムアウト期間を指定して、 「保存」をクリックします。 このタスクのタイムアウト期間は、E メール・アクティベーション・リンクと、 「セルフサービス・オンボーディングの承認」 が有効になっている場合は承認プロセスの両方を対象とします。 セルフサービス・オンボーディング・タスクのデフォルトのタイムアウト期間は 72 時間です。
期限切れのセルフサービスオンボーディングタスクは、 開発者ポータルで一日に一度だけクリアされます。 したがって、オンボーディングタスクの有効期限が切れたAPIコンシューマーは、再度サインアップを試みる前に、これらのタスクがクリアされるまで待つ必要があります。
- API コンシューマーがコラボレーターを招待してロールに割り当てる機能を構成するには、 「コンシューマーの招待とロール」 セクションで 「編集」 をクリックし、必要なオプションを選択して、 「保存」をクリックします。
- アプリケーション開発者への E メール招待で送信されるアクティベーション・リンクのタイムアウトを構成するには、 「招待タイムアウト」 セクションの 「編集」 をクリックし、タイムアウトの長さを指定してから、 「保存」をクリックします。 招待リンクのデフォルトのタイムアウト期間は 48 時間です。
- コンシューマー組織の招待によって設定されたタイムアウトをオーバーライドするには、 「コンシューマー組織の招待タイムアウトをカタログの招待タイムアウトでオーバーライドする」 を 「オン」に設定します。
代わりにカタログ独自のタイムアウト設定が使われる。
注： オンボーディング・カタログの設定は、 コンシューマー・カタログと デベロッパー・ポータルの両方に適用されます。
- このカタログ内の API へのアクセスを保護するために使用するユーザー・レジストリーを指定して、ユーザー・レジストリーをサンドボックス・カタログに追加するには、以下のステップを実行します。
- Catalog settings］ タブをクリックし、［ API user registries ］を選択する。
- 「編集」 をクリックして、使用するユーザー・レジストリーを選択します。
- 完了したら、 「保存」 をクリックします。
- このカタログのAPIへのアクセスを保護するために使用できる OAuthプロバイダを指定するには、以下の手順を実行します。
- カタログ設定のナビゲーションペインで OAuthプロバイダをクリックします。
- 「編集」をクリックして、使用する OAuth プロバイダーを選択します。
- 完了したら、 「保存」 をクリックします。
- このカタログで使用される TLS クライアント・プロファイルを構成するには、以下のステップを実行します。
注： カタログでスペースが有効になっている場合は、カタログ全体ではなく、スペースに対してTLSクライアントプロファイルを構成する。 カタログ内の 1 つのスペースで TLS クライアント・プロファイルを構成すると、そのプロファイルは、そのカタログ内のすべてのスペースにわたってゲートウェイ・サービスにデプロイされます。
スペースの有効化と管理について詳しくは、 API Connectでのシンジケーションの使用を参照してください。
- カタログ設定のナビゲーションペインで TLSクライアントプロファイルをクリックします。
- 「編集」をクリックして、このカタログで使用する TLS クライアント・プロファイルを選択します。
- 完了したら、 「保存」 をクリックします。
- カタログに基づいて開発者ポータルを構成する。
- ポータルを作成します。
- カタログで、 カタログ設定タブをクリックします。
- カタログ設定ページで、ナビゲーション・リストの 「ポータル 」をクリックします。
- 「ポータル」 ページで、 「作成」をクリックします。
- ポータルの作成ページで、ポータルサービスを選択します。
- 「作成」をクリックして変更内容を保存します。
ポータルサービスまたは URL を編集したい場合、またはポータルサイトを削除したい場合は、ポータル設定ページに戻り、 メニューアイコンをクリックして削除を選択するか、 編集タブをクリックします。
- オプション: 以下のステップを実行して、ポータルのカスタム バニティー・ホスト名 を作成できます。
開発者ポータルを作成すると、 API Connect 、コンシューマがポータルにアクセスするための URL生成されます。 コンシューマに開発者ポータルのカスタム URLを使用させたい場合は、 URLに使用するポータルのバニティホスト名を設定できます。 バニティー・ホスト名を構成するには、CNAME を使用して DNS を構成する必要があります。
- ステップ 1: バニティー・ホスト名をセットアップします。
- DNSを以下のアドレスを指すCNAMEとして設定します：
custom.<region>.apiconnect.ibmappdomain.cloud
<region> は、
API Connect アカウントがホストされている地域です。 例えば、
eu-centralの顧客の場合：
custom.eu-central-a.apiconnect.ibmappdomain.cloud
注: DNS の変更には、データの取り込みに最大 24 時間かかることがあります。
- ステップ 2: 開発者ポータルのバニティー・ホスト名を構成します。
- カタログで、 カタログ設定タブをクリックします。
- カタログ設定ページで、ナビゲーション・リストの 「ポータル 」をクリックします。
- 「ポータル」 ページで、 「編集」をクリックします。
- ポータルページで、バニティホスト名を設定する：
- 「ポータル・サイト」セクションで、 「バニティー・ホスト名の使用」を選択します。
このオプションを選択すると、バニティー・ホスト名の CNAME を構成するためのリマインダーが表示されます。 まだCNAMEを設定していない場合は、 
をクリックして、 URL をコピーし、CNAMEを設定できるようにしてください。
- 新しいカスタムホスト名DNSを入力する。例： api.CustomHost.uk.
- 「DNS の確認」 をクリックして、ホストにアクセスできることを確認します。
DNS を構成するには、リマインダーに示されているように、ホスト名が既に CNAME で構成されている必要があります。 DNS チェックが失敗した場合は、この手順を進めることができず、 IBM サポートと協力して問題を修正する必要があります。
- DNS チェックが成功したら、 「保存」をクリックします。
「カタログ設定」 ページに、更新されたポータルの設定が表示されます。
- カタログ・プロパティーを定義するには、以下のステップを実行します。
- カタログ設定ナビゲーションペインでカタログプロパティをクリックし、 作成をクリックします。
- プロパティ名と 値を入力します。
- プロパティを再編集するには、 保護チェックボックスを選択します。
注： プロパティが保護されたものとして作成された後、そのプロパティは冗長化されたままであり、値は ****** として表示される。 値を可視化したい場合は、プロパティを削除し、 Protected オプションを選択せずに再度作成してください。
- 「作成」をクリックします。
定義するプロパティーは、このカタログ内の任意の API 定義で参照できます。 API 定義に固有のプロパティーを定義することもできます。
API プロパティーの設定を参照してください。 API定義でプロパティを参照する方法については、
変数参照 API Connectを参照してください。
注:
- API プロパティーと同じ名前のカタログ・プロパティーを定義した場合、API プロパティーがカタログ・プロパティーより優先されます。
- カタログ・プロパティーの値を変更する場合、そのプロパティーを参照するすべての API は、新しい値を使用するために再公開されなければなりません。
- オプション： カタログまたはスペースに公開されている製品の可視性を設定するには、 カタログまたはスペースレベルでの製品の可視性の設定を参照してください。