註冊應用程式及管理 API 金鑰

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

請按照下列各節所述註冊應用程式及管理 API 金鑰。

簡介

應用程式註冊是控管 API 存取權的主要機制。

API 供應商會建立一或多個 API 產品來組合 API，詳情請參閱「管理 API 產品」。註冊應用程式時，應用程式開發人員會選取要使用的 API 產品，而 Edge 會提供單一 API 金鑰，開發人員可使用該金鑰存取這些 API 產品。應用程式開發人員會在對 API 產品所含 API Proxy 的每次呼叫中，傳遞 API 金鑰。您可以隨時撤銷應用程式的 API 金鑰，禁止應用程式開發人員存取該應用程式參照的所有或部分 API 產品。

應用程式開發人員通常會透過開發人員入口網站註冊，以便使用您的 API 產品。如要瞭解如何建構入口網站及發布 API 產品，請參閱「建構入口網站」。

或者，您也可以選擇在 Edge 中註冊應用程式，以便更妥善地控管應用程式註冊程序，詳情請參閱下列各節。舉例來說，您可能想為內部開發團隊註冊應用程式，或代表無法存取入口網站的開發人員註冊應用程式。

以下各節說明如何使用使用者介面和 API 註冊應用程式及管理 API 金鑰。

瀏覽「應用程式」頁面

存取及探索「應用程式」頁面，詳情請見下文。

Edge

如要使用 Edge UI 存取「應用程式」頁面，請按照下列步驟操作：

  1. 登入 apigee.com/edge。
  2. 在左側導覽列中，依序選取「發布」>「應用程式」。

系統隨即會顯示「應用程式」頁面。

如圖所示，「應用程式」頁面可讓您：

Classic Edge (Private Cloud)

如要使用傳統 Edge UI 存取「應用程式」頁面，請按照下列步驟操作：

  1. 登入 http://ms-ip:9000，其中 ms-ip 是管理伺服器節點的 IP 位址或 DNS 名稱。
  2. 在頂端導覽列中，依序選取「發布」>「開發人員應用程式」。

系統隨即會顯示「開發人員應用程式」頁面。

註冊應用程式

您可以使用下列任一方法註冊應用程式：

  • 應用程式開發人員可透過您的入口網站註冊應用程式，詳情請參閱「應用程式開發人員如何與您的入口網站互動」。
  • 您可以在 Edge 中註冊應用程式，詳情請見下文。您可自行決定如何將金鑰提供給應用程式開發人員。

已註冊的應用程式會新增至：

如要在 Edge 中註冊應用程式，請按照下列步驟操作：

  1. 存取「應用程式」頁面。
  2. 按一下「+ 應用程式」。
  3. 指定「應用程式詳細資料」：
    欄位 說明 是否必要？
    名稱 應用程式名稱。應用程式建立後即無法變更名稱。這個名稱會用於管理 API 呼叫。 是
    顯示名稱 應用程式的顯示名稱，會出現在 Edge 管理 UI 和開發人員入口網站中。 否
    公司/開發人員

    注意：Apigee Hybrid 不支援公司應用程式，因此不適用這個欄位。

    選取「公司」或「開發人員」，然後從下拉式選單中選取公司或開發人員名稱。
    注意：基於效能考量，下拉式選單不會顯示所有公司或開發人員。在搜尋框中輸入公司名稱、開發人員名稱或電子郵件地址。另請參閱「註冊應用程式開發人員」。

    		 是
    回呼網址 通常會指定應用程式的網址，該應用程式會代表用戶端應用程式接收授權碼。並非所有 API 產品都需要這個值。 否
    附註 應用程式的說明備註。 否
  4. 指定「憑證」，包括 API 金鑰到期日和狀態，以及相關聯的 API 產品。
    在「憑證」部分中，按一下 並輸入下列資訊：
    欄位 說明
    到期 設定到期時間或日期，或將 API 金鑰設為永不過期，然後按一下「確定」。
    產品 將一或多個 API 產品與 API 金鑰建立關聯：
    1. 按一下「新增產品」。
    2. 從清單中選取一或多個 API 產品。
    3. 按一下 [新增]。
    4. 為每個 API 產品將「狀態」設為「已核准」或「已撤銷」。
    5. 如要新增更多 API 產品，請重複上述步驟。
  5. 指定自訂屬性：
    1. 在「自訂屬性」部分，按一下 。
    2. 輸入名稱和值。
    3. 按一下「新增」或「新增並開始另一項」。
      最多可新增 18 個自訂屬性。
  6. 點選「建立」。

如果與應用程式相關聯的 API 產品需要手動核准 API 金鑰，請按照「核准或撤銷 API 金鑰」一文所述的步驟核准。

查看為開發人員註冊的應用程式

如要查看特定開發人員註冊的應用程式，請使用下列其中一種方法：

查看及編輯應用程式

如要查看及編輯應用程式，請按照下列步驟操作：

  1. 存取「應用程式」頁面。
  2. 按一下要查看及編輯的應用程式所在資料列。
    系統會顯示應用程式詳細資料。
  3. 如要編輯應用程式，請按一下「編輯」。
  4. 執行下列一或多項工作：
  5. 按一下 [儲存]。

管理憑證

編輯應用程式時，您可以在「憑證」部分管理憑證，如下圖所示：

如上圖所示，您可以在「憑證」部分使用 UI 執行下列工作：

如要使用 API 管理憑證，請參閱下列章節：

查看 API 金鑰和密鑰

如要查看 API 金鑰和密鑰，請按照下列步驟操作：

  1. 存取「應用程式」頁面。
  2. 在要查看 API 金鑰和密鑰的應用程式資料列中按一下。
  3. 在「憑證」部分，按一下要查看的 API 金鑰或密鑰旁邊的「顯示」。

核准或撤銷 API 金鑰

呼叫 API Proxy 的 API 通常需要 API 金鑰。只有在 API 金鑰已核准、有效，且符合包含 API 的 API 產品所定義的條件時，Edge 才會允許呼叫。

如要設定 API 產品自動核准 API 金鑰，請參閱「管理 API 產品」。 不過，如果 API 產品需要手動核准 API 金鑰，您就必須手動核准金鑰。

您可以撤銷所有或單一 API 產品的 API 金鑰。在這種情況下，API 金鑰和密鑰無效，無法用於存取相關聯 API 產品中的 API。您隨時可以重新核准 API 金鑰。

如要核准或撤銷 API 金鑰，請按照下列步驟操作：

  1. 存取「應用程式」頁面。
  2. 按一下要查看及編輯的應用程式所在資料列。
  3. 按一下 [編輯]。
  4. 執行下列任一工作：
    • 如要核准或撤銷與 API 金鑰相關聯的所有 API 產品，請選取與 API 金鑰相關聯的「已核准」或「已撤銷」。
    • 如要核准或撤銷特定 API 產品的 API 金鑰，請在 API 產品的「狀態」欄中選取「已核准」或「已撤銷」。
  5. 按一下 [儲存]。

管理應用程式中的 API 產品

執行下列工作，管理應用程式中的 API 產品：

將 API 產品新增至應用程式

如要將 API 產品新增至應用程式，請按照下列步驟操作：

  1. 存取「應用程式」頁面。
  2. 按一下要查看及編輯的應用程式所在資料列。
  3. 按一下 [編輯]。
  4. 執行下列任一工作：
    • 如要將 API 產品新增至新的 API 金鑰，請按一下 產生新的憑證，選取到期日，然後將 API 產品新增至 API 金鑰。
    • 如要將 API 產品新增至現有 API 金鑰，請在「憑證」部分按一下「新增產品」，然後從下拉式清單中選取 API 產品。
  5. 按一下 [儲存]。

從應用程式中移除 API 產品

如要讓 API 金鑰保持啟用狀態，但禁止 API 產品使用該金鑰，可以從相關聯的憑證中移除金鑰。

  1. 存取「應用程式」頁面。
  2. 按一下要查看及編輯的應用程式所在資料列。
  3. 按一下 [編輯]。
  4. 按一下 API 產品旁的 。
  5. 按一下 [儲存]。

你可以重新新增已移除的產品。

產生新憑證

您可以為應用程式產生新的憑證。舉例來說，如果您使用 API 金鑰輪替功能，可以產生新的金鑰，讓金鑰到期時，仍有其他金鑰可用。如果原始金鑰/密鑰的安全性遭到破壞，您也可以產生新的金鑰/密鑰。產生新金鑰後，現有 API 金鑰仍可繼續運作，直到過期或您明確撤銷為止。

如要產生新的 API 金鑰：

  1. 存取「應用程式」頁面。
  2. 按一下要查看及編輯的應用程式所在資料列。
  3. 按一下 [編輯]。
  4. 在「憑證」部分中，按一下 。
  5. 指定有效期限、新增 API 產品，並設定產品狀態。
  6. 視需要撤銷其他 API 金鑰。
  7. 按一下 [儲存]。

核准或撤銷應用程式

按照下列說明核准或撤銷應用程式。撤銷應用程式後，任何已核准的 API 金鑰都無法再用於呼叫 Edge 的 API。重新核准應用程式後，所有已核准且有效的 API 金鑰都能用於發出 API 呼叫。

如果應用程式已在其他機構註冊，您必須在每個機構中撤銷應用程式。所有訊息處理器可能需要幾分鐘才會辨識出變更。

如何核准或撤銷應用程式：

  1. 存取「應用程式」頁面。
  2. 按一下要查看及編輯的應用程式所在資料列。
  3. 按一下 [編輯]。
  4. 在「應用程式狀態」欄位中選取「核准」或「撤銷」，分別核准或撤銷應用程式。
  5. 按一下 [儲存]。

刪除應用程式

刪除應用程式後，與應用程式相關聯的所有用戶端金鑰都會失效。在要求中使用無效金鑰會導致要求失敗。

如果您認為日後可能需要恢復開發人員應用程式，可以撤銷應用程式，而不必刪除。

如要刪除應用程式：

  1. 存取「應用程式」頁面。
  2. 將游標放在要刪除的應用程式所在資料列。
  3. 按一下「動作」欄中的 。

注意：使用 Apigee Edge for Public Cloud 時，開發人員應用程式和相關聯構件的刪除作業會非同步進行。開發人員應用程式會立即刪除，但與該應用程式相關聯的資源 (例如應用程式金鑰或存取權杖) 可能需要幾秒到幾分鐘的時間才會自動刪除。

使用 API 註冊應用程式及管理 API 金鑰

如要使用 API 註冊及管理應用程式，請參閱「註冊開發人員應用程式」。另請參閱 API 參考說明文件的下列章節：

另請參閱匯入現有的用戶端金鑰和密鑰。