デベロッパー アプリキーの取り消しと承認

このトピックでは、UI を使って、デベロッパー アプリ内のプロダクト、あるいはデベロッパー アプリの API キーを取り消したり承認したりする方法について説明します。

UI を使ってデベロッパー アプリ内の特定の API プロダクトのキーを取り消す

管理 UI を使って、特定の API プロダクトに関連付けられたキーを取り消すことができます。これにより、その API プロダクト内で定義された API リソースは、そのキーが再承認されない限り使えなくなります。

  1. Apigee Edge のアカウントにログインします。
  2. メインメニューから、[Publish] > [Developer apps] を選択します。
  3. アプリのリストから、取り消したいキーの入ったアプリを選びます。
  4. [Developer app] のページで、[Edit] をクリックします。
  5. [Products] のセクションで、[Revoke] をクリックして、プロダクトのキーを取り消します。

ヒント: Get Developer App Details API を使って、デベロッパー アプリの JSON 表現を取得し、そのアプリ内でのプロダクトの承認状況を確認できます。次のデベロッパー アプリの JSON 表現では、「Weather-Product」という API プロダクトがどこで取り消されたのかを確認できます。

    {
      "accessType": "",
      "appFamily": "default",
      "appId": "6ed3a4d1-4733-439a-80a4-0d71149ec9ad",
      "attributes": [
        {
          "name": "DisplayName",
          "value": "AnotherTestApp"
        },
        {
          "name": "Notes",
          "value": ""
        }
      ],
      "callbackUrl": "",
      "createdAt": 1415728893126,
      "createdBy": "wwitman@apigee.com",
      "credentials": [
        {
          "apiProducts": [
            {
              "apiproduct": "Weather-Product",
              "status": "revoked"
            }
          ],
          "attributes": [],
          "consumerKey": "giIC9Au6XP82wJ1oxZuQU4L75OdNKLhb",
          "consumerSecret": "SXg8JizqeTA8j3gX",
          "expiresAt": -1,
          "issuedAt": 1415728893154,
          "scopes": [],
          "status": "approved"
        }
      ],
      "developerId": "Z2S37rxX2Suzkwtg",
      "lastModifiedAt": 1420682967414,
      "lastModifiedBy": "wwitman@apigee.com",
      "name": "AnotherTestApp",
      "scopes": [],
      "status": "approved"
    }
    

UI を使ってデベロッパー アプリ内の特定の API プロダクトのキーを承認する

管理 UI を使って、デベロッパー アプリ内で以前に取り消された API プロダクトのコンシューマ キーを承認できます。クライアント アプリはそのプロダクトの API を再び使えるようになります。

  1. Apigee Edge のアカウントにログインします。
  2. メインメニューから、[Publish] > [Developer apps] を選択します。
  3. アプリのリストから、取り消したいキーの入ったアプリを選びます。
  4. [Developer app] のページで、[Edit] をクリックします。
  5. [Products] のセクションで、[Approve] をクリックして、キーを再承認します。

Edge API を使った API プロダクトのキーの取り消しと承認

Edge には、用途に応じて API キーの状態を管理する API が用意されています。以下のデベロッパー アプリの JSON 表現では、それぞれの承認 / 取り消しフラグの位置が、次の 3 つのケースについて示されています。

  • (1)デベロッパー アプリ内の特定の API プロダクトのキーを取り消し / 承認します。この API の動作は、上で説明した UI 操作とまったく同じです。詳細については、デベロッパー アプリのキーの API プロダクトを取り消しあるいは承認するをご覧ください。
  • (2)デベロッパー アプリの特定のキーを取り消し / 承認します。キーを取り消すと、アプリは API を使うためにアクセスすることができなくなります。取り消されたアプリキーに関連付けられたすべてのアクセス トークンは有効のままですが、Apigee Edge が最初に状態を確認します。状態が「失効」となっている場合、Apigee Edge は呼び出しを許可しません。詳細については、デベロッパー アプリの特定のキーを承認あるいは認証するをご覧ください。
  • (3)デベロッパー アプリ全体の API キーの状態を取り消し / 承認します。取り消されたアプリは API プロダクトにアクセスできず、Apigee Edge が管理する API を呼び出せません。詳細は、デベロッパー アプリの承認と取り消しをご覧ください。
    {
      "accessType": "",
      "appFamily": "default",
      "appId": "6ed3a4d1-4733-439a-80a4-0d71149ec9ad",
      "attributes": [
        {
          "name": "DisplayName",
          "value": "AnotherTestApp"
        },
        {
          "name": "Notes",
          "value": ""
        }
      ],
      "callbackUrl": "",
      "createdAt": 1415728893126,
      "createdBy": "wwitman@apigee.com",
      "credentials": [
        {
          "apiProducts": [
            {
              "apiproduct": "Weather-Product",
              "status": "revoked" // (1)
            }
          ],
          "attributes": [],
          "consumerKey": "giIC9Au6XP82wJ1oxZuQU4L75OdNKLhb",
          "consumerSecret": "SXg8JizqeTA8j3gX",
          "expiresAt": -1,
          "issuedAt": 1415728893154,
          "scopes": [],
          "status": "approved" // (2) 
        }
      ],
      "developerId": "Z2S37rxX2Suzkwtg",
      "lastModifiedAt": 1420682967414,
      "lastModifiedBy": "wwitman@apigee.com",
      "name": "AnotherTestApp",
      "scopes": [],
      "status": "approved" // (3)
    }