自訂:欄位和模組
Flash 針對每個品牌提供兩種客製化方式,均基於同一共享程式碼庫,絕非分支。 自訂欄位 允許您將自己的資料新增至會員記錄中,並透過 v2 REST API 進行設定。 模組 是每個工作區可選的功能,由伺服器強制執行。本指南涵蓋以上所有內容。
字段在設定之前先聲明
擁有者或管理員可在 設定 → 自訂欄位 下建立欄位。每個欄位都有一個 `key`(其機器名稱,例如 `cf_membership_no`)、一個 `type`,以及(對於選擇類型)一個選項清單。鍵和類型一旦建立就固定不變。 `API` 從不建立欄位;它只為已存在的欄位設定值,並拒絕未知鍵-定義表即為允許清單。
在建立或更新時傳遞 customAttributes
POST /api/v2/members(建立)和 PATCH /api/v2/members/{id}(更新)都接受以您的欄位鍵為鍵的 customAttributes object。使用具有 members:write 權限範圍的 Bearer fl_live_ 金鑰進行驗證。
curl -X POST https://flash.socialhub.ai/api/v2/members \
-H "Authorization: Bearer fl_live_..." \
-H "Content-Type: application/json" \
-d '{
"email": "ada@example.com",
"fullName": "Ada Lovelace",
"customAttributes": {
"cf_membership_no": "A-10023",
"cf_preferred_store": "flagship",
"cf_child_birthday": "2018-05-01"
}
}'更新時,僅發送您想要更改的金鑰。將密鑰設為 null 會將其清除。
curl -X PATCH https://flash.socialhub.ai/api/v2/members/{id} \
-H "Authorization: Bearer fl_live_..." \
-H "Content-Type: application/json" \
-d '{ "customAttributes": { "cf_preferred_store": "airport" } }'每種欄位類型接受的內容
| 類型 | JSON 值範例 | 接受 |
|---|---|---|
text | "A-10023" | 細繩 |
number | 42 | number(或數字 string) |
date | "2018-05-01" | ISO 日期 (YYYY-MM-DD) |
boolean | true | 真/假 |
enum | "flagship" | 該領域的選擇之一 |
list | ["running","tennis"] | 字段選項的子集 |
驗證是嚴格的:值必須與其欄位的類型匹配,enum/list值必須是定義的選項之一,並且400拒絕未知的鍵。尚不接受敏感個人資料 (PII) 欄位 - 將自訂屬性保留為非敏感業務值。
平台統一使用單一值
細分市場
使用類型合適的運算符,按任意自訂欄位篩選成員-該欄位與您在 API 中設定的欄位相同。
電子郵件個人化
在副本中引用該值,格式為 {{cf_membership_no}} 或 {{member.cf_membership_no}}。
會員閱讀
在 customAttributes 下,會員 object 傳回自訂值。
選用功能,可依工作區啟用
自訂欄位新增一個 值,而模組則增加一整套 功能 — 例如服務工單模組、預約模組或維修日誌模組。模組預設關閉,並根據工作區啟用。每個工作區運行相同的程式碼庫;模組的啟用或停用狀態屬於資料(一種權限),而非私人建置。
由伺服器強制執行,集中於一處
每個模組都有一個穩定的金鑰(例如 tickets)。工作區是否可以使用此功能由每個工作區單獨設定一個開關,在一個判斷點進行檢查,並應用於模組出現的所有位置-失敗關閉:如果開關未開啟,則該功能不可用。
API
停用模組的端點拒絕使用 403 的呼叫。僅在 UI 中存取絕不是偶然的。
導航和頁面
模組的選單項目和頁面僅在工作區啟用時才會顯示,並在停用時乾淨地消失。
租戶隔離
權限依工作區劃分。一個品牌的模組和數據對其他品牌完全不可見。
如何引入新模組
當一個功能真正可重複使用時,它會作為一個模組建構一次 - 在其金鑰下的模組目錄中註冊,具有自己的資料、自己的權利門控 API 和自己的頁面。第一個需要它的工作區就會被建造;接下來只需扳動開關即可。這是該模型的核心:客戶差異表示為設置,因此一次升級或修復會立即到達每個工作區。
- 此模組使用穩定的密鑰和描述在目錄中註冊。
- 其資料和 API 路由均基於此金鑰進行存取控制(故障關閉)。
- 其導航和頁面僅在啟用密鑰後顯示。
- 擁有者為工作區啟用此功能;第二個工作區是切換,而不是重建。