本頁適用於 Apigee 和 Apigee Hybrid。
查看
Apigee Edge 說明文件。
本節說明如何註冊應用程式及管理 API 金鑰。
總覽
您可以透過應用程式註冊，控管有權存取 API 的人員。
身為 API 供應商，您可以建立一或多個 API 產品，將 API 綁定至服務層級。API 產品可讓您以非常精細的層級限制流量和存取層級。建立 API 產品時，您可以將存取層級設為「公開」、「私人」或「僅限內部」。詳情請參閱「存取層級」。
註冊應用程式時，應用程式開發人員會選取要使用的 API 產品，而 Apigee 會提供單一 API 金鑰，供開發人員用來存取這些 API 產品。應用程式開發人員會將每個呼叫中的 API 金鑰，傳遞至 API 產品中包含的 API 代理程式。您隨時可以撤銷應用程式的 API 金鑰，禁止應用程式開發人員存取該應用程式參照的所有 API 產品或其中一部分。
通常，應用程式開發人員會透過開發人員入口網站註冊使用 API 產品。如要瞭解建構入口網站和發布 API 產品的步驟，請參閱「建構入口網站」一文。
您可以改用 Cloud 控制台中的 Apigee UI 或 Apigee API 註冊應用程式，以便進一步控管應用程式註冊程序。舉例來說，您可能想為內部開發團隊或無法存取入口網站的開發人員註冊應用程式。
以下各節說明如何使用 UI 和 API 註冊應用程式及管理 API 金鑰。
探索「應用程式」頁面
如要在 Apigee UI 中查看及註冊應用程式，以及管理 API 金鑰，請使用「應用程式」檢視畫面。
前往 Cloud 控制台的 Apigee 頁面，依序前往「Distribution」>「Apps」：
您可以透過「應用程式」檢視畫面執行下列操作：
註冊應用程式
應用程式可透過下列方式註冊：
- 由應用程式開發人員註冊：應用程式開發人員可以透過您的入口網站註冊應用程式，詳情請參閱「應用程式開發人員如何與您的入口網站互動」。
- 由管理員註冊：您可以在 Apigee 中註冊應用程式，如下所述。 您可以自行決定如何將金鑰提供給應用程式開發人員。
已註冊的應用程式會新增至下列項目：
- Apigee 中註冊的應用程式清單。 請參閱「查看及編輯開發人員詳細資料」。
- 開發人員入口網站中的「應用程式」頁面。
如要在 Apigee 中註冊應用程式，請按照下列步驟操作：
- 前往「發行」>「應用程式」頁面：
- 按一下 [建立]。
- 請指定「應用程式詳細資料」，如下表所述：
欄位 說明 是否必要 名稱 應用程式名稱。應用程式建立後，您無法變更名稱。這個名稱會用於 Apigee API 呼叫。 必填 顯示名稱 應用程式在 Apigee UI 和開發人員入口網站中的顯示名稱。 選用 開發人員 從下拉式選單中選取開發人員名稱。
注意：基於效能考量，下拉式選單中不會顯示所有開發人員。在搜尋框中開始輸入開發人員名稱或電子郵件地址，系統會自動篩選下拉式選單的值，以符合您輸入的文字。另請參閱「註冊應用程式開發人員」。
必填 回呼網址 通常會指定應用程式的網址，以便代表用戶端應用程式接收授權碼。並非所有 API 產品都需要這個值。 選用 附註 應用程式的說明備註。 選用 - 指定憑證，包括 API 金鑰到期日和狀態，以及相關聯的 API 產品。在「憑證」部分中，按一下「 新增憑證」，然後輸入下列資訊：
欄位 說明 到期 選取到期時間長度或日期，或將 API 金鑰設為永不失效。 產品 將一或多個 API 產品與 API 金鑰建立關聯： - 按一下「新增產品」。
- 從清單中選取一或多項 API 產品。
- 按一下 [確定]。
- 按一下「新增」。
- 將每個 API 產品的「狀態」設為「已核准」或「已撤銷」。如果您在需要手動核准的憑證中新增 API 產品，系統會顯示
Pending approval status。否則會顯示Approved。在這個步驟中，您可以變更核准狀態。- 在「憑證」部分的「產品」清單中，選取清單中的一或多個產品。
- 按一下「核准」或「撤銷」。
- 指定自訂屬性：
- 在「自訂屬性」部分，按一下「 新增屬性」。
- 輸入名稱和值。
- 按一下「 新增屬性」。 即可新增更多屬性。您最多可以新增 18 個自訂屬性。
- 按一下 [建立]。
如果您與應用程式相關聯的 API 產品需要手動核准 API 金鑰，請按照「核准或撤銷 API 金鑰」一文所述進行核准。
查看為開發人員註冊的應用程式
如要查看特定開發人員註冊的應用程式，請使用下列任一方法：
- 查看所有已註冊的應用程式，然後依序點選 「篩選」和「應用程式擁有者」，並在搜尋欄位中輸入開發人員的名稱。
- 查看所有已註冊的應用程式開發人員，然後點選與開發人員相關聯的資料列。
查看及編輯應用程式
如何查看及編輯應用程式：
- 前往「發行」>「應用程式」頁面：
- 在要查看及編輯的應用程式資料列中，按一下任一位置。Apigee 會顯示應用程式詳細資料。
- 如要編輯應用程式，請按一下「編輯」圖示 。
- 執行下列一或多項工作：
- 按一下 [儲存]。
管理憑證
編輯應用程式時，您可以在「憑證」專區中管理憑證，並使用 UI 執行下列工作：
- 查看 API 金鑰和密鑰
- 針對所有相關聯的 API 產品或單一 API 產品，核准或撤銷 API 金鑰。
- 管理應用程式中的 API 產品
- 產生新憑證
如要使用 API 管理憑證，請參閱「匯入現有的消費者金鑰和密鑰」。
查看 API 金鑰和密鑰
如要查看 API 金鑰和密鑰：
- 前往「發行」>「應用程式」頁面：
- 找出要查看 API 金鑰和密鑰的應用程式，然後按一下該應用程式的資料列。
- 在「憑證」專區中，按一下與您要查看的 API 金鑰或密鑰相關聯的 。
核准或撤銷 API 金鑰
對 API Proxy 的 API 呼叫通常需要 API 金鑰。只有在 API 金鑰已核准、有效且符合含有該 API 的 API 產品定義的條件時，Apigee 才會允許呼叫。
您可以設定 API 產品，讓系統自動核准 API 金鑰，如管理 API 產品一文所述。不過，如果 API 產品需要手動核准 API 金鑰，您必須手動核准金鑰。
您可以撤銷所有或單一 API 產品的 API 金鑰。在這種情況下，API 金鑰和密鑰無效，無法用於存取相關 API 產品中的 API。您隨時可以重新核准 API 金鑰。
如要核准或撤銷 API 金鑰，請按照下列步驟操作：
- 前往「發行」>「應用程式」頁面：
- 按一下要查看及編輯的應用程式資料列。
- 按一下「編輯」圖示 。
- 如要核准或撤銷 API 金鑰，請在憑證的「狀態」部分，選取「已核准」或「已撤銷」。
- 按一下 [儲存]。
管理應用程式中的 API 產品
請執行下列工作，管理應用程式中的 API 產品：
在應用程式中新增 API 產品
如何在應用程式中新增 API 產品：
- 前往「發行」>「應用程式」頁面：
- 按一下要查看及編輯的應用程式資料列。
- 按一下「編輯」圖示 。
- 執行下列任一工作：
- 如要將 API 產品新增至新的 API 金鑰，請按一下「 新增憑證」，產生新的憑證、選取到期日，然後將 API 產品新增至 API 金鑰。
- 如要將 API 產品或多個產品新增至現有的 API 金鑰，請在「憑證」部分點選「新增產品」，然後從下拉式清單中選取一或多個 API 產品。
- 按一下 [儲存]。
從應用程式憑證中撤銷或移除 API 產品
如果您想讓 API 金鑰保持啟用狀態，但不允許 API 產品使用該金鑰，可以撤銷該金鑰，或從相關聯的憑證中移除該金鑰。
- 前往「發行」>「應用程式」頁面：
- 按一下要查看及編輯的應用程式資料列。
- 按一下「編輯」圖示 。
- 選取要撤銷或從憑證中移除的 API 產品。
- 按一下「撤銷」或「移除」。
- 按一下 [儲存]。
您可以重新核准遭到撤銷的 API 產品，或是重新加入已移除的 API 產品。
產生新憑證
您可以為應用程式產生新的憑證。舉例來說，如果您使用 API 金鑰輪替功能，可以產生新金鑰，讓其到期日與輪替時將會移除的金鑰重疊。如果原始金鑰/密鑰的安全性遭到破壞，您也可以產生新的金鑰/密鑰。如果您產生新的金鑰，所有現有的 API 金鑰都會繼續運作，直到過期或您明確撤銷為止。
如要產生新的 API 金鑰：
- 前往「發行」>「應用程式」頁面：
- 按一下要查看及編輯的應用程式資料列。
- 按一下 [編輯]。
- 在「憑證」部分中，按一下「新增憑證」圖示 。
- 指定到期日、新增 API 產品，並設定產品狀態。
- 視需要撤銷任何其他 API 金鑰。
- 按一下 [儲存]。
核准或撤銷應用程式
按照下列說明核准或撤銷應用程式。撤銷應用程式後，任何已核准的 API 金鑰都無法再用於 Apigee 的 API 呼叫。重新核准應用程式後，所有已核准且有效的 API 金鑰都可以用於發出 API 呼叫。
如果應用程式已在其他機構中註冊，您必須在各個機構中撤銷授權。所有訊息處理工具可能需要幾分鐘的時間，才能辨識這些變更。
如何核准或撤銷應用程式：
- 前往「發行」>「應用程式」頁面：
- 按一下要查看及編輯的應用程式資料列。
- 按一下 [編輯]。
- 在「應用程式狀態」欄位中選取「核准」或「撤銷」，即可分別核准或撤銷應用程式。
- 按一下 [儲存]。
刪除應用程式
刪除應用程式後，與該應用程式相關聯的所有用戶端金鑰都會失效。在要求中使用無效的金鑰會導致要求失敗。
如果您認為日後可能會恢復開發人員應用程式，可以撤銷應用程式，這也是刪除應用程式的替代方案。
刪除應用程式：
- 前往「發行」>「應用程式」頁面：
- 將游標移至要刪除的應用程式所在的資料列。
- 依序按一下「更多」圖示 「刪除」圖示 。
使用 API 註冊應用程式及管理 API 金鑰
如要使用 Apigee API 註冊及管理應用程式，請使用下列 API：
另請參閱匯入現有的用戶端金鑰和密鑰。