入口網站使用者如何與入口網站互動

您正在查看 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

開發人員入口網站可讓入口網站使用者建立使用者帳戶、登入，以及管理將使用 API 的應用程式。

以下各節說明入口網站使用者如何與您的入口網站互動。

登入入口網站

以下各節說明如何讓入口網站使用者使用使用者憑證 (內建的識別資訊提供者) 或 SAML (Beta 版) 登入整合式入口網站。

如果您同時啟用內建和 SAML 識別資訊提供者，入口網站使用者就能選擇偏好的登入方式。

使用使用者憑證登入入口網站 (內建身分識別提供者)

啟用內建身分識別提供者後，入口網站使用者就能使用自己的使用者憑證 (使用者名稱和密碼) 登入整合式入口網站，如以下各節所述：

在整合式入口網站上建立使用者帳戶

使用內建身分識別資訊提供者時，入口網站使用者必須在整合入口網站上建立使用者帳戶，才能使用您的 API。

如要讓 Portal 使用者在整合式入口網站上建立使用者帳戶，請按照下列步驟操作：

  1. 前往入口網站。

  2. 按一下 [登入]。

    系統會顯示「Sign in」(登入) 頁面。

  3. 按一下 [建立帳戶]。

    畫面上會顯示「建立帳戶」頁面。

    「建立帳戶」對話方塊

  4. 完整填寫表單。

    您必須為所有必填欄位輸入值。密碼至少必須為 8 個字元，且應包含下列項目中的至少一個：數字、小寫字母、大寫字母和特殊字元。

  5. 詳閱並同意條款。

  6. 按一下「建立帳戶」。

  7. 填寫驗證碼表單，然後點選「驗證」 (如有顯示)。

    系統會建立使用者帳戶，並傳送確認電子郵件。

  8. 請在 10 分鐘內點選確認電子郵件中的連結，完成註冊程序。

    如果您未在 10 分鐘內點選連結，就必須重複執行本程序中的步驟來建立帳戶，並重新接受提示。

  9. 登入整合式入口網站 (如下所述)。

登入整合式入口網站

使用內建的 ID 提供者後，在整合式入口網站上註冊並獲得核准的入口網站使用者，就能使用憑證 (使用者名稱和密碼) 登入。

入口網站使用者可透過以下方式登入：

  1. 前往入口網站。
  2. 按一下「登入」。登入頁面會顯示： 登入頁面
  3. 輸入電子郵件地址和密碼。
  4. 按一下 [登入]。

變更密碼

使用內建的 ID 提供者時，Portal 使用者可按照下列步驟變更密碼：

  1. 前往入口網站。
  2. 按一下 [登入]。
  3. 按一下「重設密碼」。
  4. 輸入要重設的帳戶電子郵件地址。

  5. 按一下「傳送重設密碼連結」。

    系統會將重設密碼連結傳送到電子郵件。

  6. 按一下確認電子郵件中的連結。

  7. 輸入並確認新密碼。

    密碼至少必須為 8 個字元，且應包含下列項目中的至少一個：數字、小寫字母、大寫字母和特殊字元。

  8. 按一下「建立新密碼」。

使用 SAML 驗證功能登入入口網站 (Beta 版)

啟用 SAML 識別資訊提供者後，入口網站使用者會使用 SAML 驗證登入整合式入口網站，如下所示：

  1. 前往入口網站。
  2. 按一下 [登入]。

  3. 按一下「使用 SAML 登入」。

    系統會將您重新導向至 SAML 供應器。

  4. 系統可能會要求您輸入 SAML 識別資訊提供者的憑證。

查看 API 參考資料說明文件

入口網站使用者可以查看您發布至入口網站的 API 參考說明文件，如下所示：

  1. 前往入口網站。

  2. 按一下頂端導覽列中的「API」。畫面隨即顯示「API」頁面。例如：

    「API」頁面

  3. 如有需要，請使用左側窗格中的工具，依類別、標題或說明篩選 API 清單。

  4. 按一下 API 資訊卡，即可查看 API 參考資料說明文件。系統會顯示 API 參考資料說明文件。

Portal 使用者可以瞭解並試用 API，或下載用於轉譯 API 參考說明文件的文件。如要進一步瞭解如何顯示 API 參考說明文件，請參閱「發布 API」。

使用開發人員團隊分擔應用程式的責任 (Beta 版)

開發團隊可讓 Portal 使用者與其他 Portal 使用者共用應用程式的責任。以下各節將說明如何建立及管理開發人員團隊。

關於開發人員團隊角色

下表列出可指派給開發人員團隊成員的角色：

角色 說明
應用程式管理員
  • 開發團隊成員和開發團隊詳細資料的唯讀權限。
  • 應用程式的讀取和寫入權限。
擁有者 開發人員團隊成員、開發人員團隊詳細資料和應用程式的完整讀取及寫入權限。
檢視者 開發團隊成員、開發團隊詳細資料和應用程式的唯讀權限。

查看「Teams」頁面

「團隊」頁面會顯示您所屬的開發人員團隊。

如要存取「Teams」頁面，請按照下列步驟操作：

  1. 登入入口網站。
  2. 在入口網站的使用者帳戶下拉式選單中，選取「Teams」。

系統隨即會顯示「Teams」頁面，您可以執行以下操作：

新增開發人員團隊

如要新增開發人員團隊，請按照下列步驟操作：

  1. 登入入口網站。
  2. 在入口網站的使用者帳戶下拉式選單中，選取「Teams」。
  3. 按一下「+ 新增團隊」。
  4. 輸入名稱和說明。

  5. 如要將成員加入開發人員團隊，請按一下「+ 新增其他成員」，輸入入口網站使用者的電子郵件地址，然後選取開發人員團隊角色。

    如要新增其他成員，請重複上述步驟。

  6. 如要從開發人員團隊中刪除成員，請按一下要刪除的開發人員團隊成員旁邊的 「刪除」圖示。

  7. 按一下「建立」。

編輯開發人員團隊成員資格和角色

如要編輯開發人員團隊成員和角色，請按照下列步驟操作：

  1. 登入入口網站。
  2. 在入口網站的使用者帳戶下拉式選單中，選取「Teams」。
  3. 按一下您要編輯的開發人員團隊 (您必須是該團隊的擁有者) 所在的資料列。

  4. 請執行下列一或多個步驟：

    • 編輯名稱、說明和主要聯絡人。
    • 新增或移除開發團隊成員。
    • 更新開發人員團隊成員的角色。

  5. 按一下 [儲存]。

將自己從開發人員團隊中移除

如要將自己從開發人員團隊中移除，請按照下列步驟操作：

  1. 登入入口網站。
  2. 在入口網站的使用者帳戶下拉式選單中，選取「Teams」。
  3. 按一下要移除自己所在開發團隊的資料列。
  4. 按一下「離開團隊」。

刪除開發人員團隊

如要刪除開發人員團隊，請按照下列步驟操作：

  1. 登入入口網站。
  2. 在入口網站的使用者帳戶下拉式選單中，選取「Teams」。
  3. 按一下要刪除的開發人員團隊所在的資料列。
  4. 按一下「「刪除」圖示」。
  5. 按一下「確認」確認刪除。

註冊應用程式

註冊開發人員應用程式和開發人員團隊應用程式，詳情請參閱以下各節。

註冊開發人員應用程式

入口網站使用者可以註冊應用程式，以便使用您發布的 API，如下所示：

  1. 從使用者帳戶下拉式選單中選取「應用程式」。
  2. 按一下「+ 新增應用程式」，建立新的應用程式。
  3. 在「New App」對話方塊中輸入應用程式的名稱和說明。

  4. 在「Owner」下拉式清單中選取應用程式的擁有者。

    根據預設，您是應用程式的擁有者。如有需要，請從下拉式選單中選取開發團隊，與其他開發團隊成員共用應用程式的責任。請參閱「使用開發人員團隊 (Beta 版) 分擔應用程式責任」。

  5. 在「API 目錄」部分中，選取一或多個 API。

    目錄中的 API 分為需要回呼網址的已驗證 API 和公開 API。您必須至少選取一個 API，才能建立應用程式。

  6. 如果您在「已驗證的 API」部分中選取 API，請輸入回呼網址。

    詳情請參閱「關於回呼網址」。

  7. 按一下「建立」。

註冊開發人員團隊應用程式

開發團隊成員可以為開發團隊註冊應用程式，以便使用您發布的 API，如下所述。

如要進一步瞭解如何：

如要註冊開發人員團隊應用程式，請按照下列步驟操作：

  1. 從使用者帳戶下拉式選單中選取「Teams」。
  2. 按一下要為其註冊應用程式的開發人員團隊資料列。
  3. 按一下「+ 新增應用程式」，建立新的應用程式。
  4. 在「New App」對話方塊中輸入應用程式的名稱和說明。

  5. 在「Owner」下拉式清單中選取應用程式的擁有者。

    根據預設，開發人員團隊是應用程式的擁有者。如有需要，請從下拉式選單中選取其他開發人員團隊或自己做為擁有者。

  6. 在「API 目錄」部分中，選取一或多個 API。

    目錄中的 API 分為需要回呼網址的已驗證 API 和公開 API。您必須至少選取一個 API，才能建立應用程式。

  7. 如果您在「已驗證的 API」部分中選取 API，請輸入回呼網址。

    詳情請參閱「關於回呼網址」。

  8. 按一下「建立」。

管理應用程式中的 API

身為 API 製作者，您可以發布 API，讓入口網站使用者能夠使用您的 API 產品。

Portal 使用者可管理應用程式使用的 API。系統會將 API 新增至應用程式詳細資料頁面。部分 API 不會自動核准。如果狀態為「等待核准」，表示您已要求存取權，但尚未獲得核准。

入口網站使用者可以透過入口網站管理應用程式中的 API，方法如下：

  1. 從使用者帳戶下拉式選單中選取「應用程式」。
  2. 按一下清單中的應用程式。
  3. 在「API」部分中，按一下 啟用圖示 或 停用圖示，分別啟用或停用應用程式對 API 的存取權。
  4. 針對已驗證的 API，視需要新增或編輯回呼網址。

查看應用程式的 API 金鑰和密鑰

入口網站使用者可以透過入口網站管理應用程式的 API 金鑰，方法如下：

  1. 從使用者帳戶下拉式選單中選取「應用程式」。
  2. 按一下清單中的應用程式。
  3. 在「API 金鑰」專區中查看 API 金鑰。
  4. 確認 API 金鑰的狀態為「有效」。如果 API 金鑰需要核准，且尚未獲得核准，狀態會顯示為「待核准」。
  5. 按一下「顯示密鑰」即可查看密鑰。
  6. 將游標移至 API 金鑰或密鑰，然後按一下 delete-icon 將其複製到剪貼簿。

輪替應用程式的 API 金鑰

入口網站使用者可以定期輪替應用程式的 API 金鑰，也可以在發現潛在的資料外洩或遭入侵時輪替。當入口網站使用者輪替 API 金鑰時，系統會建立新的 API 金鑰，並賦予與原始金鑰相同的 API 授權。原始 API 金鑰在您停用後仍會保持有效狀態。您必須撤銷舊的 API 金鑰，才能避免系統接受其憑證，如「撤銷應用程式的 API 金鑰」一文所述。

入口網站使用者可以透過入口網站輪替應用程式的 API 金鑰，步驟如下：

  1. 從使用者帳戶下拉式選單中選取「應用程式」。
  2. 按一下清單中的應用程式。
  3. 在「API 金鑰」專區中，按一下「新增金鑰」。
  4. 在對話方塊中按一下「確認」，確認作業。
  5. 視需要撤銷舊的 API 金鑰，詳情請參閱下文。

撤銷應用程式的 API 金鑰

當入口網站使用者輪替 API 金鑰時 (如上一個章節所述)，API 金鑰會在您停止使用時保持有效狀態。您必須撤銷 API 金鑰，才能避免憑證遭到接受。

入口網站使用者可以從入口網站撤銷應用程式的 API 金鑰，方法如下：

  1. 從使用者帳戶下拉式選單中選取「應用程式」。
  2. 按一下應用程式名稱。
  3. 在「API 金鑰」專區中，按一下與要撤銷的 API 金鑰相關聯的「動作」欄中的 「撤銷」圖示。

  4. 按一下「確認」確認操作。

    金鑰的狀態已更新為「已撤銷」。

編輯應用程式詳細資料

入口網站使用者可以編輯應用程式詳細資料，方法如下：

  1. 從使用者帳戶下拉式選單中選取「應用程式」。
  2. 按一下清單中的應用程式。
  3. 編輯「應用程式詳細資料」分頁中的「名稱」或「說明」欄位。
  4. 視需要管理應用程式中的 API。
  5. 按一下 [儲存]。

刪除應用程式

入口網站使用者可以從入口網站中刪除應用程式，方法如下：

  1. 從使用者帳戶下拉式選單中選取「應用程式」。
  2. 按一下清單中的應用程式。
  3. 點選「DELETE」(刪除)。
  4. 按一下「確認」確認操作。

系統會刪除應用程式，並將其從「應用程式」清單中移除。