メインコンテンツまでスキップ

APIサイトの管理

API Siteの管理

SiteはProductとPortalをマッピングするために使用されるエンティティです。

PilotまたはNormalプランをご利用の場合、デフォルトのPublic Siteが提供されており、新しいSiteを追加作成することはできません。複数のSiteを使用したい場合は、上位プランにアップグレードしてください。

1. 新しいSiteの作成​

ステップ1： ApplicationメニューからAPI Manager > Sitesに移動し、Createをクリックします。

ステップ2： 必要な情報を入力します。

  • Name： Site名。
  • Title： タイトル。
  • Production mode： Productモードを選択します。
  • Virtual area： 管理者が事前に設定したリストから仮想エリアを選択します。
  • Gateway： 管理者が事前に設定したリストからGatewayを選択します。
  • Portal： 管理者が事前に設定したリストからPortalを選択します。

ステップ3：OKをクリックしてSiteを作成します。

2. Site情報の変更​

Siteの情報を変更するには、以下の手順で操作します。

ステップ1： Site Managementで変更するSiteを選択し、Editをクリックします。

ステップ3： 新しい情報を入力し、OKをクリックします。

注意： 一部のフィールドは変更できず、編集インターフェースで無効化されます。その他のフィールドはSite作成時と同じバリデーションルールに従う必要があります。

3. Productのステージング​

Siteにproductを公開するには、まずproductをSiteにステージングする必要があります。

注意： productがSiteにステージングされても、consumerはそのproduct内のAPIをまだ使用できません。consumerがproductにアクセスできるようになるには、productをpublishする必要があります。

productをSiteに割り当てるには、以下の手順で操作します。

ステップ1： Product ManagementでSiteに公開するProductを選択し、Stagingをクリックします。

ステップ2： Staging to New siteをクリックします。

ステップ3： 必要な情報を入力します。

  • Product：Siteに割り当てるProduct。
  • Site to publish：事前に作成したSiteを選択します。

ステップ4： OKをクリックします。

注意：

  • 1つのSiteに複数のProductを含めることができます。
  • 1つのProductを複数のSiteで使用できます。
  • Siteは、そのSite上でどのProductが表示されるかを決定します（子ProductのAPIも含む）。

4. Site内のProductステータスの管理​

Productをステージングした後、Siteに直接アクセスして、含まれているProductとその動作ステータスを管理できます。

特定のSite内のProductを管理するには、以下の手順で操作します。

ステップ1： Site Managementで管理するProductが含まれるSiteを選択します。

ステップ2： Productをクリックします。

ここではProductのリストとSite内でのステータスが表示されます。

Productのステータスには次のものがあります：Unstaging、Staging、Published、Deprecated、Retired、Archived。

ステータス間の関係は以下の図で説明されています。

  • Published状態では、そのProductに割り当てられたconsumerのみがProductを閲覧・使用できます。
  • Deprecated状態では、新しいconsumerはProductを見ることができませんが、既存のconsumerは引き続き使用できます。
  • Retired状態では、既存のconsumerもProductを使用できなくなります。
  • Archived状態では、Productを削除できます。Archived状態のProductを管理するにはArchived productsタブに移動します。

5. ProductのEndpointの取得​

Published状態の各ProductにはconsumerがAPIを呼び出すためのEndpointがあります。

ProductのEndpointを取得するには、以下の手順で操作します。

ステップ1： Site ManagementでProductが含まれるSiteを選択し、Productをクリックします。

ステップ2： Productを選択し、Manage Apiをクリックします。

ステップ3： Endpoint情報はAPI EndPoint列に表示されます。

6. 開発者Portalの管理​

Siteをpublishすると、Portalページが作成されます。このページはSite上にpublishされたProductのリストと各ProductのAPIを管理するために使用されます。

Portalリンクを取得するには、以下の手順で操作します。

ステップ1： メニューからSitesに移動し、Siteを選択してEditをクリックします。PortalリンクはPortal URLフィールドに表示されます。

ステップ2：そのリンクにアクセスすると、以下のインターフェースのページが表示されます。

ログインするには、ユーザー名とパスワードを含むアカウントが必要です。アカウント情報の提供については、お問い合わせください。

7. IPアクセス制御の管理​

セキュリティを強化するために、API Providerは特定のIPアドレスからのconsumerによるAPI呼び出しを許可またはブロックできます。

ステップ1：メニューからSitesに移動し、Published状態のProductを持つSiteを選択します。

ステップ2：API Browserをクリックし、詳細パネルでEnable IP Limitationにチェックを入れます。

ステップ3：許可/拒否するIPを入力します。

  • AllowにIPを入力した場合：consumerはこれらのIPアドレスからAPIを呼び出せます。

  • DenyにIPを入力した場合：consumerはこれらのIPアドレスからAPIを呼び出せません。

  • AllowにIPを入力しDenyが空の場合：AllowリストのIPのみがAPIにアクセスできます。

  • DenyにIPを入力しAllowが空の場合：DenyリストのIPを除くすべてのIPがAPIにアクセスできます。

    • 注意：1つのIPアドレスを同時に許可かつ拒否することはできません。

8. テスト​

ConsumerにAPI情報を共有する前に、publishされたAPIが正しく動作しているかどうかをAPI Management内で直接テストできます。

以下の手順に従ってください。

ステップ1：API ManagerメニューからSite > Product > Manage APIに移動し、テストするAPIを選択します。

ステップ2：Test APIまたはTest With Consumerをクリックします。

例として、Test With Consumerの場合：

  1. Consumerドロップダウンに表示されているサブスクライブ済みconsumerを選択します。

  2. 対応するHTTPメソッド（GET/POST/PUT/DELETE）を選択します。

  3. API Endpointの前に**https://**を付加します。

例：https:// gateway.apim.fptcloud.com/demo/truong11/newapi

  1. 認証方式を選択します。

– Basic：システムは選択したconsumerのユーザー名を自動的に取得します。パスワードを入力するだけです。パスワードの取得方法は「consumerの認証情報を取得する」セクションを参照してください。

  • – API key：システムはキー名を自動的に取得します。キーの値を入力するだけです。キー値の取得方法は「consumerの認証情報を取得する」セクションを参照してください。
  1. CallをクリックしてAPIを呼び出します。結果はResponseフィールドに表示されます。
にDang Tranが最終更新