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

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

查看 Apigee Edge 說明文件。

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

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

登入入口網站

以下各節說明入口網站使用者如何使用使用者憑證 (內建身分識別提供者) 或 SAML (搶先版) 登入整合式入口網站。

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

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

注意：除了變更公司標誌 (如「 設定使用者帳戶的建立和登入體驗」一文所述)，您無法編輯登入頁面。

啟用內建身分識別提供者後，入口網站使用者就能使用使用者憑證 (使用者名稱和密碼) 登入整合式入口網站，詳情請參閱下列章節：

• 在整合式入口網站上建立使用者帳戶
• 登入整合式入口網站
• 變更密碼

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

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

重點：另請參閱「應用程式開發人員帳戶資訊的儲存位置」。

雖然可以使用 Apigee UI 手動為入口網站使用者建立使用者帳戶 (如「註冊應用程式開發人員」一文所述)，但為確保整合式入口網站上的使用者帳戶與 Apigee 上的開發人員記錄保持同步，建議不要這麼做。

入口網站使用者在整合式入口網站中建立帳戶的方式如下：

1. 前往入口網站。

2. 按一下 [登入]。

   系統會顯示「Sign in」頁面。

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

   系統會顯示「建立帳戶」頁面。

   

   注意：如要將自訂註冊欄位新增至帳戶建立頁面，請參閱「將自訂註冊欄位新增至帳戶建立頁面」。

4. 填妥表單。

   請務必為所有必填欄位輸入值。密碼至少須有 8 個字元，且應包含至少一個數字、一個小寫字母、一個大寫字母和一個特殊字元。

5. 詳閱並同意條款。

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

   注意：如果嘗試使用已註冊的電子郵件 ID 建立帳戶，系統會顯示訊息，指出帳戶已存在，並鼓勵入口網站使用者改為登入。

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

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

   注意：您可以按照「設定電子郵件通知」一文的說明，設定確認電子郵件。Apigee 建議您先設定用於入口網站電子郵件通知的 SMTP 伺服器，再啟動入口網站，如「設定 SMTP 伺服器」一節所述。

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

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

9. 登入整合式入口網站 (詳情請見下文)。

登入整合式入口網站

使用內建身分識別資訊提供者時，入口網站使用者在整合式入口網站上註冊並獲得核准後，即可使用憑證 (使用者名稱和密碼) 登入。

注意事項：

• 如果閒置時間超過 24 小時，工作階段就會過期，入口網站使用者會自動登出，必須重新登入。
• 如果已將整合式入口網站設定為必須手動啟用使用者帳戶，您必須手動啟用使用者帳戶，入口網站使用者才能登入。目前，入口網站使用者不會收到任何提示，指出必須先手動啟用註冊，才能登入。建議您設定手動啟用時，加快新使用者帳戶的啟用速度。
• 如要直接前往登入頁面，請使用下列網址：
  https://portal-url/login

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

1. 前往入口網站。

2. 按一下「登入」。 「登入」頁面會顯示：

   

3. 輸入電子郵件地址和密碼。

4. 按一下 [登入]。

變更密碼

使用內建身分識別提供者時，入口網站使用者可依下列步驟變更密碼：

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

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

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

   注意：如要設定 SMTP 伺服器，請參閱「設定 SMTP 伺服器」。

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

7. 輸入新密碼並確認。

   密碼至少須有 8 個字元，且應包含至少一個數字、一個小寫字母、一個大寫字母和一個特殊字元。

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

使用 SAML 驗證登入入口網站 (預先發布版)

注意：這是 SAML 識別資訊提供者的預先發布版。

注意：除了變更公司標誌外，登入頁面無法編輯。如要變更公司標誌，請參閱「 設定使用者帳戶的建立和登入體驗」一文。

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

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

3. 按一下「login with SAML」。

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

4. 如果系統提示，請輸入 SAML 識別資訊提供者的憑證。

注意：如果使用者閒置 24 小時，工作階段就會過期，入口網站使用者會自動登出，必須重新登入。

查看 API 參考文件

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

1. 前往入口網站。

2. 按一下頂端導覽列中的「API」。 系統會顯示「API」頁面。例如：
   
   

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

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

入口網站使用者可以瞭解及試用 API，或下載用於算繪 API 參考說明文件的文件。如要進一步瞭解 API 參考說明文件的顯示方式，請參閱「發布 API」。

使用開發人員團隊共管應用程式 (搶先體驗版)

注意：您必須 註冊使用團隊功能的預先發布版

。

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

重點：瀏覽開發人員入口網站時，開發人員團隊簡稱為「團隊」。

關於開發團隊角色

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

注意：開發人員團隊成員可以從任何開發人員團隊移除自己，無論角色為何，但開發人員團隊擁有者除外。

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

查看「團隊」頁面

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

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

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

系統會顯示「團隊」頁面，方便您執行下列操作：

• 查看您所屬的開發人員團隊，包括名稱、角色、成員清單和團隊建立日期
• 新增開發人員團隊
• 按一下開發人員團隊資料列，即可編輯開發人員團隊成員和角色、從開發人員團隊中移除自己，或刪除團隊

新增開發人員團隊

注意：入口網站使用者可以在「團隊」頁面查看自己所屬的開發人員團隊。在預先發布版本中，將入口網站使用者新增至開發人員團隊時，系統不會傳送通知。

如要新增開發人員團隊：

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

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

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

   注意：

   • 系統會自動將您新增為開發人員團隊的擁有者。
   • 使用者最多可加入 16 個開發人員團隊。

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

7. 點選「建立」。

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

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

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

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

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

     • 開發人員團隊至少須有一位擁有者。
     • 使用者最多可加入 16 個開發人員團隊。

5. 按一下 [儲存]。

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

注意：開發人員團隊成員可以從任何開發人員團隊中移除自己，無論開發人員團隊角色為何，但開發人員團隊擁有者除外。

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

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

刪除開發人員團隊

注意：刪除開發人員團隊後，該團隊擁有的所有應用程式都會一併刪除。

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

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

註冊應用程式

請按照下列各節所述，註冊開發人員應用程式和開發人員團隊應用程式。

註冊開發人員應用程式

重點：入口網站使用者註冊開發人員應用程式後，使用者帳戶資訊會同步至 Apigee，並顯示在「開發人員」頁面。請參閱「應用程式開發人員帳戶資訊的儲存位置」。

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

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

4. 在「API」部分，啟用一或多個 API。

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

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

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

6. 按一下 [儲存]。

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

注意：只有已加入團隊功能搶先體驗計畫，才需要執行這個步驟。在預先發布版中，應用程式建立後就無法轉移擁有權。

開發人員團隊成員可以為開發人員團隊註冊應用程式，以便使用您發布的 API，詳情請參閱下文。

注意：只有在成員為團隊註冊應用程式後，Apigee 才會新增開發人員團隊實體。請參閱「開發人員團隊資訊的儲存位置 (預覽版)」。

如要進一步瞭解如何：

• 入口網站使用者可以新增及管理團隊，詳情請參閱「使用開發人員團隊共同承擔應用程式管理責任 (搶先體驗)」。
• API 提供者可以查看及管理開發人員團隊，詳情請參閱「管理開發人員團隊 (預覽版)」。

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

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

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

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

   注意： 在預先發布版本中，應用程式建立後就無法轉移擁有權。

6. 在「API 目錄」專區中，啟用一或多個 API。

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

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

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

8. 按一下 [儲存]。

管理應用程式中的 API

身為 API 產生者，您需要發布 API，讓入口網站使用者取用您的 API 產品。

入口網站使用者可管理應用程式使用的 API。API 會新增至應用程式詳細資料頁面。部分 API 不會自動核准，「待核准」狀態表示您已要求存取 API，但尚未獲准。

注意：目前系統不會顯示未發布的 API，但我們會在日後推出的版本中修正這個問題。

如果入口網站使用者停用僅限私人或內部使用的 API 存取權，該 API 會從應用程式中移除，且必須由入口網站管理員手動重新新增，如「註冊應用程式來控管 API 存取權」一文所述。

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

1. 從使用者帳戶下拉式選單中選取「應用程式」。
2. 按一下清單中的應用程式。
3. 在「API」部分中，按一下「啟用」或「停用」存取權，即可在應用程式中新增或移除 API。
4. 如果是已驗證的 API，請視需要新增或編輯回呼網址。
5. 按一下 [儲存]。

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

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

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

注意：如果使用者帳戶或應用程式已停用/撤銷，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. 按一下 [刪除]。
4. 按一下「確認」確認操作。

應用程式會遭到刪除，並從「應用程式」清單中移除。