站台品牌設定 API
說明整合端如何依站台網域取得公開品牌顯示設定。
同一個後端服務不同品牌站台時,登入前的頁面也需要知道站台名稱、圖像與連結。整合端可從目前站台的網域呼叫 GET /api/branding/,取得該站台的公開顯示設定。這個讀取端點不需要登入。
讀取與套用
透過服務該站台的網域送出
GET /api/branding/。品牌由請求的 Host 決定,不是由使用者、組織 ID 或查詢參數選擇。從回應讀取需要的顯示欄位。例如
siteName用於站台名稱,logoFullUrl用於完整標誌,primaryColor用於主色。欄位為
null時,隱藏對應元素;不要自行填入其他品牌的預設素材。若網域沒有專屬設定,服務會先使用系統預設品牌;連預設品牌也沒有時,所有欄位均為null。
回應欄位
HTTP 200 回傳 JSON 物件,欄位採 camelCase:
用途
欄位
文字
siteName、assistantName、supportEmail、poweredByText
圖像 URL
faviconUrl、logoMarkUrl、logoFullUrl、logoAnimatedUrl、assistantIconUrl、ogImageUrl
顏色
primaryColor、splashBackgroundColor、splashTextColor、progressBarColor
連結
docsUrl、termsUrl、privacyUrl、loginRedirectUrl
所有欄位都可能是 null。圖像欄位是可供顯示的 URL;整合端應直接使用回應值,不要自行組合媒體路徑。
最後更新於
這有幫助嗎?