應用程式開發人員與入口網站的互動方式 (原始版本)

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

開發人員入口網站可直接存取 API，方便應用程式開發人員註冊、登入及管理會存取 API 的應用程式。

以下各節說明應用程式開發人員如何與您的入口網站互動：

Edge 如何追蹤應用程式開發人員註冊和登入情形

在 Edge 中使用 _apiportal 自訂屬性，追蹤開發人員註冊狀態和入口網站登入活動。

如果開發人員自行註冊，系統會將 _apiportal 自訂屬性加入開發人員設定，並將開發人員狀態設為 unverified，表示開發人員尚未登入入口網站。例如：{"status":"unverified","portals":{}}

開發人員首次登入入口網站時，系統會更新 _apiportal 自訂屬性以追蹤入口網站名稱和存取時間，並將開發人員狀態設為 active。開發人員每次登入入口網站時，系統都會更新自訂屬性，以重設該入口網站的 lastVisit 值 (採用 Epoch 紀元時間格式)。例如：{"status":"active","portals":{"myorg-myportal":{"lastVisit":1480972935}}}

註冊應用程式開發人員帳戶

應用程式開發人員必須先建立帳戶以註冊 API，才能使用您的 API。

當應用程式開發人員向您的入口網站註冊時：

或者，您也可以按照「註冊應用程式開發人員」一文的說明，使用 Edge UI 代表應用程式開發人員註冊。

新應用程式開發人員可以按照下列步驟，透過入口網站自行註冊：

  1. 前往入口網站。
  2. 按一下「登入」。

  3. 按一下「申請」。
    系統會顯示下列對話方塊。

    建立帳戶

  4. 輸入必要資訊 (名字、姓氏和電子郵件地址)。

  5. 點選「建立」。
    系統會顯示下列對話方塊。

    登入入口網站

  6. 按一下電子郵件中的安全連結即可開啟入口網站，並建立通過驗證的工作階段。

登入入口網站

應用程式開發人員註冊您的入口網站後，會使用「登入」頁面登入。

每當應用程式開發人員登入入口網站時 (而不是使用密碼等共用密鑰驗證開發人員)，系統就會傳送安全連結，以便驗證身分並透過入口網站建立工作階段。

應用程式開發人員可以按照下列步驟登入入口網站：

  1. 前往入口網站。
  2. 點選「登入」。
  3. 輸入與帳戶相關聯的電子郵件地址。

  4. 按一下 [登入]。
    系統會顯示下列對話方塊。

    登入入口網站

  5. 按一下電子郵件中的安全連結即可開啟入口網站，並建立通過驗證的工作階段。

註冊應用程式

登入入口網站後，應用程式開發人員可以註冊應用程式，使用您發布的 API 產品，方法如下：

  1. 從使用者下拉式選單中選取「我的應用程式」。
  2. 按一下「+ 應用程式」建立新的應用程式。
  3. 在「Create App」對話方塊中輸入應用程式的名稱和說明。
  4. 按一下「Create」(建立)。
  5. 按照下文說明管理應用程式中的 API 產品。

管理應用程式中的 API 產品

應用程式開發人員可以管理應用程式中的 API 產品。API 產品會新增至應用程式詳細資料頁面。某些 API 產品不會自動核准。「待處理」狀態表示已要求存取權，但尚未授予存取權的 API 產品。

應用程式開發人員可以透過入口網站管理應用程式中的 API 產品，方法如下：

  1. 從使用者下拉式選單中選取「我的應用程式」。
  2. 按一下應用程式名稱。
  3. 按一下「管理產品」。

  4. 按一下「存取權」切換鈕，即可啟用或停用應用程式的 API 產品存取權。

    注意：如果應用程式開發人員停用僅限非公開或內部使用的 API 產品存取權，系統會將 API 產品從應用程式中移除，而入口網站管理員必須按照「註冊應用程式及管理 API 金鑰」一文的說明手動重新加入產品。

  5. 按一下「要求」，即可針對尚未核准的 API 產品提出核准要求。

  6. 按一下「儲存」。

查看應用程式的 API 金鑰

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

  1. 從使用者下拉式選單中選取「我的應用程式」。
  2. 按一下應用程式名稱。
  3. 查看「Keys」區段中的 API 金鑰。
  4. 按一下「查看密鑰」，顯示 API 金鑰密鑰。
  5. 確認 API 金鑰的狀態為「已核准」。

輪替應用程式的 API 金鑰

應用程式開發人員可以定期輪替應用程式的 API 金鑰，或是因應裝置可能外洩或遭盜用的情況。當應用程式開發人員輪替 API 金鑰時，系統會建立新的 API 金鑰，並沿用原始金鑰的 API 產品授權。原始 API 金鑰已標示為已淘汰，但在轉換未使用期間，該金鑰將維持有效狀態。如「停用應用程式的 API 金鑰」一節所述，您必須停用已淘汰的金鑰，以免系統接受憑證。

應用程式開發人員可以從入口網站輪替應用程式的主要 API 金鑰，方法如下：

  1. 從使用者下拉式選單中選取「我的應用程式」。
  2. 按一下應用程式名稱。
  3. 在「Keys」(金鑰) 部分，將遊標移到目前的 API 金鑰上，即可顯示動作選單。
  4. 按一下 展開圖示 展開動作選單。
  5. 按一下「旋轉」。
  6. 按一下對話方塊中的「建立」來確認作業。
  7. 或者，按照下文說明停用 API 金鑰。

停用應用程式的 API 金鑰

應用程式開發人員如上一節所述，輪替 API 金鑰時，該 API 金鑰會標示為已淘汰，但在您轉用不到的期間，該金鑰仍然有效。您必須停用已淘汰的金鑰，以免系統接受其憑證。

應用程式開發人員可以透過入口網站停用應用程式的 API 金鑰，方法如下：

  1. 從使用者下拉式選單中選取「我的應用程式」。
  2. 按一下應用程式名稱。
  3. 在「金鑰」區段中，按一下「金鑰記錄」，顯示已淘汰金鑰的清單。
  4. 將遊標移到您要停用的已淘汰 API 金鑰上，以顯示動作選單。
  5. 按一下 展開圖示 展開動作選單。
  6. 按一下「停用」。
  7. 按一下「停用」來確認作業。
    金鑰狀態會更新為「已撤銷」。

編輯應用程式詳細資料

應用程式開發人員可以按照下列步驟編輯應用程式詳細資料：

  1. 從使用者下拉式選單中選取「我的應用程式」。
  2. 按一下應用程式名稱。
  3. 編輯「名稱或說明」欄位。
  4. 按一下「儲存」。

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

刪除應用程式

應用程式開發人員可以透過下列步驟刪除入口網站中的應用程式：

  1. 從使用者下拉式選單中選取「我的應用程式」。
  2. 按一下應用程式名稱。
  3. 按一下頁面右上角的「刪除」。

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