面向外部開發人員搭建 API 自助服務網站,集中展示和管理 API 產品、審批開發人員註冊、管理訂閱關係。本文介紹如何建立、配置和管理入口網站。
什麼是門戶
門戶(Portal)是開放平台中面向外部開發人員的自助服務網站。管理員可以在控制台建立和配置門戶,將 API 產品發布到門戶;開發人員訪問門戶後註冊帳號,即可瀏覽和訂閱發行的 API 產品。每個門戶擁有獨立的配置和 API 產品集合。
通過門戶,你可以實現以下目標:
展示發行的 API 產品,供開發人員瀏覽和檢索。
管理開發人員註冊和訂閱,支援自動審批或手動審批。
提供 AI API 使用入口(HiChat),方便開發人員快速調用 AI 能力。
建立門戶
登入開放平台管理頁面。
點擊 建立門戶。
在彈出的對話方塊中,填寫以下資訊:
參數
說明
名稱
門戶的唯一標識,用於區分不同的門戶。例如
ai-platform。描述
簡要描述門戶的用途和定位,以便管理員快速識別。
點擊 確定,完成建立。
配置門戶
建立門戶後,在門戶列表頁點擊目標門戶卡片進入詳情頁,可對以下模組進行配置和管理。
門戶概覽
查看門戶的基礎資訊,包括名稱、描述和相關統計資料。
發行的 API 產品
管理當前門戶中發行的 API 產品,包括髮布新產品到門戶和從門戶下架已有產品。
開發人員管理
在開發人員管理頁面,你可以執行以下操作:
查看在該門戶註冊的開發人員列表。
審批開發人員的註冊申請。
查看開發人員的 API 產品訂閱情況。
安全設定
配置審批策略,簡化或規範開發人員的註冊和訂閱流程。
開發人員自動審批:開啟後,開發人員註冊帳號時審批自動通過;關閉後,需要管理員在開發人員管理頁面手動審批。
訂閱自動審批:開啟後,開發人員訂閱 API 產品時審批自動通過;關閉後,需要管理員在開發人員管理頁面手動審批。
刪除門戶
在門戶列表頁右上方,選擇 刪除門戶。
在彈出的確認對話方塊中,點擊 確定。
門戶刪除後,該門戶上註冊的開發人員帳號將被刪除,發行的 API 產品均會下架。請謹慎操作。
後續操作
建立門戶後,你可以進行以下操作,讓門戶正式投入運行:
將 API 產品發布到門戶,讓開發人員可以在門戶中瀏覽和訂閱。
在開發人員管理中處理註冊申請和審批訂閱請求。