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

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊

按照下列各節說明，註冊應用程式及管理 API 金鑰。

引言

應用程式註冊提供的主要機制，可讓您控管哪些人員能夠存取您的 API。

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

一般來說，應用程式開發人員會透過開發人員入口網站註冊使用 API 產品。請參閱「建構入口網站」一文，瞭解建構入口網站及發布 API 產品的步驟。

或者，API 供應商可能會想進一步控管應用程式註冊流程，並選擇在 Edge 中註冊應用程式，詳情請參閱以下各節。舉例來說，您可以為內部開發團隊註冊應用程式，或在無法存取入口網站的情況下代表開發人員註冊應用程式。

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

探索應用程式頁面

存取及探索「應用程式」頁面 (如下所述)。

Edge

如何使用 Edge UI 存取「應用程式」頁面：

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

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

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

傳統邊緣 (Private Cloud)

如何使用傳統版 Edge UI 存取「應用程式」頁面：

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

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

註冊應用程式

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

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

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

如何在 Edge 中註冊應用程式：

  1. 存取「應用程式」頁面。
  2. 按一下「+ 應用程式」。
  3. 指定「App Details」(應用程式詳細資料)：
    欄位 說明 必填與否
    名稱 應用程式名稱。應用程式建立後即無法變更名稱。這個名稱會用於管理 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. 執行下列一或多項工作：
    • 修改應用程式詳細資料，包括名稱、回呼網址或附註。
    • 管理憑證。
    • 新增或刪除自訂屬性。
      您最多可以新增 18 項自訂屬性。
    • 核准或撤銷應用程式。
  5. 點按「儲存」。

管理憑證

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

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

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

查看 API 金鑰和密鑰

如何查看 API 金鑰和密鑰：

  1. 存取「應用程式」頁面。
  2. 找出要查看 API 金鑰和密鑰的應用程式，然後按一下對應的應用程式列。
  3. 在「憑證」專區中，針對要查看的 API 金鑰或密鑰，按一下相關的「顯示」。

核准或撤銷 API 金鑰

呼叫 API Proxy 通常需要 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 金鑰，請在該 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. 按一下「Credentials」(憑證) 區段中的 。
  5. 指定到期日、新增 API 產品，並設定這些產品的狀態。
  6. 視需要revoke任何其他 API 金鑰。
  7. 點按「儲存」。

核准或撤銷應用程式

」

依照下方說明核准或撤銷應用程式。撤銷應用程式後，所有已核准的 API 金鑰都無法再用於向 Edge 發出的 API 呼叫。當您重新核准應用程式後，所有已核准且有效的 API 金鑰都可以用於執行 API 呼叫。

如果應用程式已在其他機構註冊，您必須在各機構中撤銷該應用程式。系統可能需要幾分鐘的時間，才能讓所有訊息處理器辨識到這些變更。

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

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

刪除應用程式

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

如果您認為日後可能想要恢復某個開發人員應用程式，除了刪除之外，還有撤銷應用程式的替代方案。

如要刪除應用程式：

  1. 存取「應用程式」頁面。
  2. 找出要刪除的應用程式列，然後將遊標定位在該應用程式列中。
  3. 按一下動作欄中的 。

注意：使用適用於公用雲端的 Apigee Edge 時，以非同步方式刪除開發人員應用程式和相關聯的構件。開發人員應用程式會立即刪除，但與該開發人員應用程式相關聯的資源 (例如應用程式金鑰或存取權杖) 可能需要幾秒到幾分鐘就會自動刪除。

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

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

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