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

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

透過立即可用的開發人員入口網站,入口網站使用者即可建立使用者帳戶、登入及管理即將存取 API 的應用程式。

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

登入入口網站

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

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

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

內建識別資訊提供者啟用後,入口網站使用者就能透過自己的使用者憑證 (使用者名稱和密碼) 登入整合式入口網站,詳情請參閱下列各節:

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

透過內建的識別資訊提供者,入口網站使用者必須先在整合式入口網站建立使用者帳戶,才能使用您的 API。

入口網站使用者在整合式入口網站上建立使用者帳戶,如下所示:

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

    系統隨即會顯示「登入」頁面。

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

    「建立帳戶」頁面隨即顯示。

    建立您的帳戶對話方塊

  4. 完整填寫表單。

    您必須為所有必填欄位輸入值。密碼至少必須包含 8 個字元,並包含下列至少一個:數字、小寫字母、大寫字母和特殊字元。

  5. 詳閱並同意條款。

  6. 按一下「建立帳戶」

  7. 填寫人機驗證 (Captcha) 表單,然後按一下「驗證」 (如果系統顯示)。

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

  8. 在 10 分鐘內按一下確認電子郵件中的連結,以完成註冊程序。

    如果您未在 10 分鐘內按下該連結,就必須重複這個程序來建立帳戶並再次接收提示。

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

登入整合式入口網站

在內建識別資訊提供者中,入口網站使用者完成整合式入口網站註冊並獲得核准後,即可使用自己的憑證 (使用者名稱和密碼) 登入。

入口網站使用者登入方式如下:

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

變更密碼

透過內建的識別資訊提供者,入口網站使用者會變更密碼,方法如下:

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

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

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

  7. 輸入新密碼並確認。

    密碼至少必須包含 8 個字元,並包含下列至少一個:數字、小寫字母、大寫字母和特殊字元。

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

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

SAML 識別資訊提供者啟用後,入口網站使用者就能按照下列方式使用 SAML 驗證登入整合式入口網站:

  1. 前往入口網站。
  2. 按一下 [登入]
  3. 按一下「login with SAML」

    系統會將您重新導向至 SAML 提供者。

  4. 如果出現提示,請輸入 SAML 識別資訊提供者的憑證。

查看 API 參考資料說明文件

入口網站使用者可以查看已發布至入口網站的 API 參考說明文件,方法如下:

  1. 前往入口網站。
  2. 按一下頂端導覽列中的「API」。系統隨即會顯示「API」頁面。例如:

    API 頁面

  3. 使用左側窗格中的工具,按照類別、標題或說明篩選 API 清單。

  4. 按一下 API 資訊卡,查看 API 參考說明文件。API 參考資料文件會隨即顯示。

入口網站使用者可以瞭解並試用 API,或是下載用於轉譯 API 參考說明文件的文件。如要進一步瞭解 API 參考說明文件的轉譯方式,請參閱「發布 API」。

透過開發人員團隊共同承擔應用程式的責任 (Beta 版)

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

關於開發人員團隊角色

下表摘要說明可指派給開發人員團隊成員的角色:

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

查看團隊頁面

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

如何存取「小組」頁面:

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

「小組」頁面會隨即顯示,可讓您:

新增開發團隊

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

  1. 登入入口網站。
  2. 在入口網站的使用者帳戶下拉式選單中,選取「團隊」
  3. 按一下「+ 新增團隊」
  4. 輸入名稱和說明。
  5. 如要新增開發人員團隊的成員,請按一下「+ 新增其他成員」,輸入入口網站使用者的電子郵件地址,然後選取開發人員團隊角色

    如要新增更多成員,請重複以上步驟。

  6. 如要從開發團隊成員刪除成員,請在要刪除的開發人員團隊成員旁,按一下旁邊的 刪除圖示

  7. 點選「建立」

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

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

  1. 登入入口網站。
  2. 在入口網站的使用者帳戶下拉式選單中,選取「團隊」
  3. 找出要編輯的開發人員團隊,以及你具備擁有者的身分。
  4. 請執行下列一或多個步驟:

    • 編輯姓名、說明和主要聯絡人。
    • 新增或移除開發人員團隊成員。
    • 更新開發人員團隊成員角色。
  5. 點按「儲存」

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

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

  1. 登入入口網站。
  2. 在入口網站的使用者帳戶下拉式選單中,選取「團隊」
  3. 找出您要移除的開發人員團隊所在列,然後按一下該列。
  4. 按一下「離開團隊」

刪除開發人員團隊

如要刪除開發人員團隊:

  1. 登入入口網站。
  2. 在入口網站的使用者帳戶下拉式選單中,選取「團隊」
  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. 從使用者帳戶下拉式選單中選取「團隊」
  2. 按一下您要註冊應用程式的開發人員團隊列。
  3. 按一下「+ 新增應用程式」建立新的應用程式。
  4. 在「New App」對話方塊中輸入應用程式的名稱和說明。
  5. 在「Owner」下拉式清單中,選取應用程式的擁有者。

    根據預設,開發人員團隊即為應用程式的擁有者。您可以視需要從下拉式選單中選取其他開發人員團隊,或是您自己為擁有者。

  6. 在「API 目錄」專區中,選取一或多個 API。

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

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

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

  8. 點選「建立」

在應用程式中管理 API

API 生產者可以發布 API,讓入口網站使用者使用您的 API 產品。

入口網站使用者可管理應用程式使用的 API。系統會將 API 新增至應用程式詳細資料頁面。某些 API 並不會自動核准。「待審核」狀態表示已要求存取權,但尚未授予存取權的 API。

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

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

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

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

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

輪替應用程式的 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. 按一下「確認」確認作業。

應用程式遭到刪除後,就會從應用程式清單中移除。