開発者ポータル REST API の呼び出し

開発者ポータルのコンテキスト内で開発者ポータル API にアクセスするには、X-IBM-APIManagement-Context ヘッダーを構成するか、開発者ポータル REST API を直接呼び出すか、X-Override-Host ヘッダーを使用するかの 3 つの中から任意の方式を使用できます。

始める前に

2 番目の方式を使用して開発者ポータル REST API を直接呼び出す場合、最初にドメイン・ネーム・サーバー (DNS) レコードを構成する必要があります。

基本ホスト名を構成するには、DNS レコードをセットアップします。例えば、manage.dev.acme.com です。
DNS レコードが API Connect 管理サーバーの IP アドレスを指し示すようにします。

重要: 基本ホスト名を作成する場合、構成される名前が API Connect クラスター全体で固有になるようにする必要があります。

このタスクについて

開発者ポータル REST API を呼び出すために使用できる 3 つの方式は以下のとおりです。

方式 1: X-IBM-APIManagement-Context ヘッダーを構成する。この場合、各 API 呼び出しに必要な各プロバイダー組織およびカタログの管理サービス・アドレスを指定する必要があります。
方式 2: 開発者ポータル REST API を直接呼び出す。カスタム開発者ポータルを使用する場合、各 API 呼び出しに使用できる管理サービス別名アドレス (開発者ポータル API ホスト名) を作成できます。この方式が動作するためには、事前に DNS レコードを構成しておく必要があります。
方式 3: X-Override-Host ヘッダーを使用する。カスタム開発者ポータルを使用している場合、DNS レコードを作成せずに開発者ポータル REST API を直接呼び出すことができますが、管理サービス別名アドレス (開発者ポータル API ホスト名) が必要です。

注:

方式 2 または方式 3 を使用し、かつカスタム開発者ポータルを使用している場合、API Manager の「カタログ」設定の「開発者ポータル API 呼び出しのホスト名」フィールドで開発者ポータル API ホスト名を構成できます。ホスト名を構成することで、ユーザーがホスト名を検索して呼び出しに含める代わりに、API Manager がホスト名を開発者ポータル API 呼び出しのプロバイダー組織とカタログにマップすることができます。IBM 開発者ポータルを使用している場合、開発者ポータル API ホスト名は構成しません。
処理するカタログに対して「ポータル代行ユーザー・レジストリー」が選択されている場合、開発者ポータル REST API は使用できません。これは、ユーザー管理が開発者ポータルに委任されるために、管理サーバーがユーザー認証を提供できなくなるためです。詳しくは、ポータル代行ユーザー・レジストリーの使用を参照してください。
開発者ポータル REST API を使用するには、カタログで IBM 開発者ポータルまたはカスタム開発者ポータルを使用している必要があります。必要な開発者ポータル・タイプを指定するために、カタログで開発者ポータルを構成するときに、「IBM 開発者ポータル」または「その他」を選択します。詳しくは、カタログの作成および構成を参照してください。
開発者ポータルのユーザー・アカウントのログイン資格情報を使用して、開発者ポータル REST API 呼び出しを認証します。

手順

方式 1: X-IBM-APIManagement-Context ヘッダーを構成する。
ヘッダーは以下の形式で構成します。
```
provider_organization_name.catalog_short_name
```
説明:
- provider_organization_name はプロバイダー組織の URL パス・セグメントです。
- catalog_short_name はプロバイダー組織が保管されるカタログの URL パス・セグメントです。
例えば、次のようになります。
```
curl -k -i -H "X-IBM-APIManagement-Context: provider_organization_name.catalog_short_name" -X GET https://management_service_address/v1/portal/products
```
注: 開発者ポータル REST API は、https://management_service_address/v1/portal を使用して呼び出されます。ここで、management_service_address は、マップされていない元の管理サービスホスト名または IP アドレスです。
方式 2: 開発者ポータル REST API を直接呼び出す。
1. (カスタム開発者ポータルのみ。IBM 開発者ポータルを使用している場合はこのステップを実行しないでください) 以下のステップを実行して、管理サービス別名アドレスを構成します。
  1. 目的の開発者ポータルのカタログの所有者として API Manager UI にログインします。
  2. 前に UI ナビゲーション・ペインをピン留めしていなかった場合は、「ナビゲート先」アイコンをクリックします。API Manager UI ナビゲーション・ペインが開きます。UI ナビゲーション・ペインをピン留めするには、「メニューのピン留め」アイコンをクリックします。
  3. API Manager の「ダッシュボード」セクションで作業対象のカタログを選択します。
  4. 必要なカタログをクリックして詳細を表示し、その後「設定」をクリックします。
  5. 「構成」をクリックします。
  6. 「エンドポイント」をクリックします。
  7. 「ポータル」をクリックします。
  8. 「開発者ポータル API 呼び出しのホスト名」フィールドにホスト名を入力し、「保存」をクリックします。
2. 以下のルート URL を使用して開発者ポータル API を呼び出します。
```
https://management_service_address/v1/portal
```
  ここで、management_service_address には以下の値のいずれかが設定されます。
  - IBM 開発者ポータルを使用している場合は、管理サービスのホスト名 IP アドレス。
  - カスタム開発者ポータルを使用しており、管理サービス別名を構成済みの場合は、管理サービス別名のホスト名。
  例えば、次のようになります。
```
curl -k -i -X GET https://management_service_address/v1/portal/products
```
  重要: https://alias_management_service_address を使用して開発者ポータル REST API を直接呼び出すには、このホスト名の DNS レコードをセットアップする必要があります。
方式 3: X-Override-Host ヘッダーを使用する。 DNS レコードをセットアップできない場合は、各開発者ポータル API 呼び出しで X-Override-Host ヘッダーを使用し、マップされていない管理サービス・アドレスを呼び出しで使用します。
1. (カスタム開発者ポータルのみ。IBM 開発者ポータルを使用している場合はこのステップを実行しないでください) 以下のステップを実行して、管理サービス別名アドレスを構成します。
  1. 目的の開発者ポータル向けのカタログの所有者として API Manager UI にログインします。
  2. 前に UI ナビゲーション・ペインをピン留めしていなかった場合は、「ナビゲート先」アイコンをクリックします。API Manager UI ナビゲーション・ペインが開きます。UI ナビゲーション・ペインをピン留めするには、「メニューのピン留め」アイコンをクリックします。
  3. API Manager の「ダッシュボード」セクションで作業対象のカタログを選択します。
  4. 必要なカタログをクリックして詳細を表示し、その後「設定」をクリックします。
  5. 「構成」をクリックします。
  6. 「エンドポイント」をクリックします。
  7. 「ポータル」をクリックします。
  8. 「開発者ポータル API 呼び出しのホスト名」フィールドにホスト名 (manage.dev.acme.com など) を入力し、「保存」をクリックします。
2. 開発者ポータル API 呼び出し用の以下のコマンドを使用します。例を示します。
```
curl -k -i -H ‘X-Override-Host: manage.dev.acme.com’ -X GET https://management_service_address/v1/portal/products  
```
  ここで、management_service_address はマップされていない管理サービスのホスト名または IP アドレスです。
すべての要求は HTTPS 方式を使用します。セキュアでない HTTP によるアクセスはありません。管理ノードによって提供されるデフォルトの証明書は、自己署名済みです。

最終更新: 2017 年 11 月 1 日