API プロダクトとは

API プロダクトはリソース(API プロキシなど)をバンドルします。これにより、クライアント アプリのデベロッパー向けに特定のアクセスレベルと機能が提供されます。API プロダクトは通常、一連の API プロキシとアクセス制限、API キー承認方法を指定することに加えて、バンドルのすべてのプロキシ用に必要なその他の構成を指定します。

API プロダクトの作成方法を確認するには、API プロダクトを作成するをご覧ください。

ビジネスでの用途

ビジネス上の観点では、API プロダクトはプロダクト ラインと考えることができます。クライアント アプリ デベロッパー向けの特定のサービスレベルの API をバンドルする API プロダクトを作成できます。さまざまな API プロダクト(同じ API プロキシをバンドルしている場合も含む)が、さまざまな用途向けのサービスレベルを提供します。デベロッパーに一連のリソースを単に提示するのではなく、特定のリソースをまとめてバンドルすると、特定のユーザーニーズを解決するプロダクトを作成できます。

デベロッパーが API プロダクトにアクセスする手段は、クライアント アプリです。デベロッパーがアプリを登録するとき、アプリに関連付ける API プロダクトを選択すると、Apigee によりそのアプリの API キーが生成されます。デフォルトでは、1 つのキーで、アプリに関連付けられたすべての API 製品へのアクセス権が与えられます。アプリがリクエストを実行すると、Apigee は最初に API キーが有効であることを検証し、有効でない場合はリクエストが失敗します。

デベロッパーは API にアクセスするアプリを構築します。ただし、アプリを登録するには、まずデベロッパーが組織に登録されている必要があります。

アプリの作成方法については、アプリの登録と API キーの管理をご覧ください。デベロッパーの登録方法を確認するには、アプリ デベロッパーの管理をご覧ください。

たとえば、次のことが可能です。

  • 内部デベロッパー、または有料顧客だけがアクセスできるリソースをバンドルする。
  • API プロダクトごとに特殊な機能セットを作成するために、API プロキシを組み合わせる。
  • バンドルされたプロキシへのアクセスを低く抑え(たとえば 1 日あたり 1,000 リクエスト)、その後、バーゲン価格でアクセスを提供する。
  • 高い価格では、同じプロキシに高いレベルでアクセスできるようにする。
  • 1 つの API プロダクトのプロキシ経由での特定リソースの読み取り専用アクセスを提供し、その後、別の API プロダクトで同じリソースへの読み取り/書き込みアクセスを販売する。

技術的な用途

技術的な観点からは、以下の作業を行う場合に API プロダクトを作成できます。

  • API キーのサポートを追加する。API プロダクトに関連付けられたデベロッパー アプリで、キーが生成されることがあります。実施するには、API プロキシでポリシーを使用して着信 API キーを検証します。API キーは API 自体ではなく、API プロダクト用にプロビジョニングされます。

    デフォルトでは、アプリからの API プロダクトへのすべてのキーリクエストが自動的に承認されます。代わりに、キーを手動で承認するよう選択することもできます。プロダクトの作成時に Edge 管理 UI でこのオプションを設定した場合、API プロダクトを追加するあらゆるアプリからのキーリクエストを承認する必要があります。詳細については、アプリの登録と API キーの管理をご覧ください。

  • アクセス割り当てのサポートを追加する(1 分あたりの許容リクエスト数の制限など)。API プロダクトの構成でデフォルトが指定され、API プロキシの割り当てポリシーで詳細が処理されます。

    割り当ての構成については、割り当てポリシーをご覧ください。割り当てポリシーでのプロダクト割り当て設定の使用については、https://community.apigee.com/questions/1488/how-do-the-quota-settings-on-an-api-product-intera.html をご覧ください。

  • OAuth スコープのサポート。バンドルされた API プロキシに進むためにリクエストの OAuth トークンに含める必要のある OAuth スコープが、API プロダクトで指定されることがあります。

    Edge OAuth ポリシーでスコープを使用する方法については、OAuth2 スコープの操作をご覧ください。

API プロダクトの構成

管理コンソールで API プロダクトを作成できます。プロダクトを作成する編集ページを以下に示します。

API プロダクトの作成の詳細については、API プロダクトの作成をご覧ください。

管理 API を使って API プロダクトを作成するとき、次のように JSON を使用して API プロダクトの構成を POST します。

API を使用して API プロダクトを作成する方法の詳細については、API プロダクトの作成をご覧ください。

    {
      "apiResources": [
        "/"
      ],
      "approvalType": "auto",
      "attributes": [
        {
          "name": "access",
          "value": "public"
        }
      ],
      "createdAt": 1452706896178,
      "createdBy": "wwitman@apigee.com",
      "description": "",
      "displayName": "SC-PRODUCT-UNLIMITED",
      "environments": [
        "test",
        "prod"
      ],
      "lastModifiedAt": 1452706896178,
      "lastModifiedBy": "wwitman@apigee.com",
      "name": "SC-PRODUCT-UNLIMITED",
      "proxies": [
        "foodcarts",
        "menus",
        "items",
        "users",
        "accesstoken"
      ],
      "quota": "1000000",
      "quotaInterval": "1",
      "quotaTimeUnit": "minute",
      "scopes": [
        "owner.read",
        "owner.create",
        "owner.update",
        "owner.delete",
        "reviewer.create",
        "reviewer.read",
        "manager.update",
        "manager.read"
      ]
    }