註冊應用程式來控管 API 存取權

本頁內容適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

本節說明如何註冊應用程式及管理 API 金鑰。

總覽

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

API 供應商會建立一或多個API 產品，將 API 組合為服務層級。API 產品可讓您在非常精細的層級限制流量和存取層級。建立 API 產品時，存取層級只能設為「公開」、「私人」或「內部」。詳情請參閱「存取層級」。

註冊應用程式時，應用程式開發人員會選取要使用的 API 產品，而 Apigee 會提供單一 API 金鑰，開發人員可使用這組金鑰存取這些 API 產品。應用程式開發人員會在對 API 產品所含 API Proxy 的每次呼叫中，傳遞 API 金鑰。您可以隨時撤銷應用程式的 API 金鑰，禁止應用程式開發人員存取該應用程式參照的所有或部分 API 產品。

如果應用程式開發人員是透過 AppGroup 成員資格存取 API 產品，註冊應用程式時會使用與個別應用程式開發人員類似的方法，但註冊時會一併提供 AppGroup 成員資格。

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

如要進一步控管應用程式註冊程序，請改用 Apigee UI 或 Apigee API 註冊應用程式。舉例來說，您可能想為內部開發團隊或無法存取入口網站的開發人員註冊應用程式。

您必須是機構管理員，或獲派具備適當權限的角色，才能註冊應用程式及管理 API 金鑰。

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

瀏覽「應用程式」頁面

如要在 Apigee UI 中查看及註冊應用程式，並管理 API 金鑰，請使用「應用程式」檢視畫面。

前往 Apigee in Cloud 控制台的「Distribution」>「Apps」頁面：

前往「應用程式」

您可以在「應用程式」檢視畫面中執行下列操作：

• 註冊應用程式
• 查看及編輯應用程式
• 管理憑證
• 核准或撤銷應用程式
• 刪除應用程式
• 依名稱、開發人員、應用程式 ID、消費者 API 金鑰或所有內容搜尋應用程式清單

注意：隨著應用程式總數增加，「應用程式」檢視畫面上的載入時間延遲會增加。使用篩選器縮小應用程式清單範圍，並縮短載入時間。

註冊應用程式

警告：請務必確保應用程式至少包含一個API 產品，且至少指定一個 API 代理和/或資源路徑。如果 API 產品未包含 API Proxy 和/或資源路徑，應用程式的金鑰可用於呼叫 Apigee 機構中的任何 API Proxy。在大多數情況下，您不會想建立所謂的「萬用鑰匙」，也就是能打開家中任何門的鑰匙！

應用程式的註冊方式如下：

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

已註冊的應用程式會新增至下列項目：

• Apigee 中已註冊的應用程式清單。 請參閱「查看及編輯開發人員詳細資料」。
• 開發人員入口網站中的「應用程式」頁面。

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

1. 前往「發行方式」>「應用程式」頁面：

   前往「應用程式」

2. 點選「建立」。
3. 指定「應用程式詳細資料」，如下表所述：

   欄位	說明	是否必要
   名稱	應用程式名稱。應用程式建立後即無法變更名稱。這個名稱會用於 Apigee API 呼叫。	必填
   顯示名稱	應用程式的顯示名稱，會出現在 Apigee 使用者介面和開發人員入口網站中。	選用
   開發人員	從下拉式選單中選取開發人員名稱。 注意：基於效能考量，下拉式選單不會顯示所有開發人員。在搜尋框中輸入開發人員名稱或電子郵件地址，下拉式選單值會自動調整，以符合您輸入的文字。另請參閱「註冊應用程式開發人員」。	必填
   回呼網址	通常會指定應用程式的網址，該應用程式會代表用戶端應用程式接收授權碼。並非所有 API 產品都需要這個值。	選用
   附註	應用程式的說明附註。	選用

   注意：應用程式詳細資料也包含應用程式 ID，但只能透過 API 查看及編輯，無法透過使用者介面操作。請參閱 REST 資源：organizations.developers.apps。
4. 指定「憑證」，包括 API 金鑰到期日和狀態，以及相關聯的 API 產品。在「憑證」部分中，按一下「新增憑證」，然後輸入下列資訊：

   欄位	說明
   期限	選取到期時間長度或日期，或將 API 金鑰設為永不過期。
   產品	將一或多個 API 產品與 API 金鑰建立關聯： 按一下「新增產品」圖示 。 從清單中選取一或多個 API 產品。 注意：至少須選取一項 API 產品。 按一下 [確定]。 按一下「新增」。

5. 為每個 API 產品將「狀態」設為「已核准」或「已撤銷」。如果您為需要手動核准的憑證新增 API 產品，系統會顯示 Pending approval status。否則會顯示 Approved。在這個步驟中，您可以變更核准狀態。
   1. 在「憑證」部分的「產品」清單中，選取一或多個產品。
   2. 按一下「核准」或「撤銷」。
6. 指定自訂屬性：
   1. 在「自訂屬性」部分，按一下「新增屬性」圖示 。
   2. 輸入名稱和值。
   3. 按一下「新增屬性」。 即可新增更多屬性。最多可新增 18 個自訂屬性。
7. 點選「建立」。

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

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

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

• 查看所有已註冊的應用程式，點按「篩選器」，點按「應用程式擁有者」，然後在搜尋欄位中輸入開發人員名稱。
• 查看所有已註冊的應用程式開發人員，然後點按與開發人員相關聯的資料列。

查看及編輯應用程式

注意：編輯自訂屬性前，請確認現有的屬性設定沒有任何系統依附元件。

Apigee 會在存取實體後，將下列實體保留在快取中至少 180 秒。

• OAuth 存取權杖。也就是說，OAuth v2 政策中的 ExpiresIn 元素無法在 180 秒內使存取權杖失效。
• 金鑰管理服務 (KMS) 實體 (應用程式、開發人員、API 產品)。
• OAuth 權杖和 KMS 實體的自訂屬性。

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

1. 前往「發行方式」>「應用程式」頁面：

   前往「應用程式」

2. 按一下要查看及編輯的應用程式所在資料列中的任意位置。Apigee 會顯示應用程式詳細資料。
   注意：結果清單中也會顯示 AppGroup 中的應用程式。 您可以在這個檢視畫面中查看應用程式詳細資料及刪除 AppGroup 應用程式，但無法建立或編輯。如需管理 AppGroups 和 AppGroups 應用程式的操作說明，請參閱「使用 AppGroups 整理應用程式擁有權」。
3. 如要編輯應用程式，請按一下「編輯」圖示 。
4. 執行下列一或多項工作：
   • 修改應用程式詳細資料，包括名稱、回呼網址或附註。
   • 管理憑證和相關聯的產品。
   • 新增或刪除自訂屬性。最多可新增 18 個自訂屬性。
   • 核准或撤銷應用程式。
5. 按一下 [儲存]。

管理憑證

編輯應用程式時，您可以在「憑證」部分管理憑證，並透過 UI 執行下列工作：

• 查看 API 金鑰和密鑰
• 核准或撤銷所有相關聯 API 產品或單一 API 產品的 API 金鑰。
• 管理應用程式中的 API 產品
• 產生新憑證

如要使用 API 管理憑證，請參閱「匯入現有的用戶端金鑰和密鑰」。

注意：建立 API 產品時，您也可以將存取層級設為「僅限內部」或「私人」。標示為「僅限內部」或「私人」的 API 產品不會顯示在開發人員入口網站中。如要存取這些產品，請從 Apigee API 手動將產品新增至開發人員的應用程式。

查看 API 金鑰和密鑰

如要查看 API 金鑰和密鑰：

1. 前往「發行方式」>「應用程式」頁面：

   前往「應用程式」

2. 在要查看 API 金鑰和密鑰的應用程式資料列中按一下。
3. 在「憑證」專區中，按一下要查看的 API 金鑰或密鑰相關聯的 。

核准或撤銷 API 金鑰

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

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

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

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

1. 前往「發行方式」>「應用程式」頁面：

   前往「應用程式」

2. 按一下要查看及編輯的應用程式所在資料列。
3. 按一下「編輯」圖示 。
4. 如要核准或撤銷 API 金鑰，請在憑證的「狀態」部分選取「已核准」或「已撤銷」。
5. 按一下 [儲存]。

管理應用程式中的 API 產品

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

• 將 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. 按一下「撤銷」或「移除」。
6. 按一下 [儲存]。

您可以重新核准已撤銷的 API 產品，或重新新增已移除的 API 產品。

產生新憑證

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

如要產生新的 API 金鑰：

1. 前往「發行方式」>「應用程式」頁面：

   前往「應用程式」

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

核准或撤銷應用程式

注意：您可以核准或撤銷與特定使用者相關聯的應用程式，詳情請參閱「管理入口網站使用者」一文。

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

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

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

1. 前往「發行方式」>「應用程式」頁面：

   前往「應用程式」

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

刪除應用程式

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

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

如要刪除應用程式：

1. 前往「發行方式」>「應用程式」頁面：

   前往「應用程式」

2. 將游標放在要刪除的應用程式所在資料列。
3. 依序點選「動作」欄中的「更多」「刪除」。

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

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

如要使用 Apigee API 註冊及管理應用程式，請使用下列 API：

• 應用程式 API
• 開發人員應用程式 API
• 開發人員應用程式金鑰 API

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