Glossary

文件裡每一個名詞,用一句話講清楚它指哪個東西、對應哪一頁。看不懂某個詞時先來這裡,再回去讀指南。

017 個詞條

平台與租戶

「你的東西」在 HSystem 裡叫什麼:App、金鑰、方案、點數。

應用程式

App

你在 HSystem 建立的軟體單位。服務、用戶、金鑰、方案都掛在它底下,跨 App 的資料不會互通。

憑證與認證 →

用戶端識別碼

client_id

App 的公開識別碼。放前端沒問題,它不是密碼;用來告訴 API「這是哪一個 App」。

App 金鑰 →

App 金鑰

client_secret

代表 App 本人的密鑰,只能放後端。外洩等於別人可以代你的 App 呼叫 API、讀寫你的用戶資料。

App 金鑰 →

代理權杖

Agent Token

給自動化腳本與 AI 代理的開發者權杖,帶 scope(例如 pay:write);可隨時撤銷,不必共用登入密碼。

方案

plan

一個 App 只能選一個平台方案;方案決定每個服務的免費額,超出才扣點。

平台點數

HCoin

平台計費用的點數。用量超過方案免費額時扣點,餘額不足會直接回 429,不會默默超收。

錯誤代碼 →

服務

service

可上架的能力模組(auth、profile、pay、files…)。每個服務有自己的開關、設定與 OpenAPI 契約。

API 參考 →

029 個詞條

身分與登入

「這個請求是誰發的」:終端用戶、token、授權與遮蔽。

終端用戶

end user

使用你的 App 的人。ID 建立後不更換,一個人在平台上只有一列。

身份驗證 →

用戶池

user pool

依池分開存放的用戶資料。換池只切換正在讀寫的那一份,不另建用戶、不改寫 ID。

身份驗證 →

存取權杖

access_token

代表某個終端用戶的短期票,放在 Authorization: Bearer。只能碰自己的資料(除非用 App 金鑰)。

使用者 access_token →

更新權杖

refresh_token

用來換新的 access_token。與 Auth 共用;撤銷後就換不到新票。

資料權限

dataScopes

每個個資欄位(email、顯示名稱、頭像…)的分享策略:允許、遮蔽或不提供。

資料權限(三態) →

授權

grant

使用者同意某個 App 使用哪些資料的紀錄。可撤銷;撤銷後相關請求回 403,而不是假裝成功。

身份驗證 →

訪客

guest

免註冊的身份,每個 App 各自獨立。升級成正式帳號時同一個 user id 遷入正式池。

訪客 →

遮蔽

masking

未取得授權的個資以遮蔽形式回傳(例如 a***@example.com)。這是正常結果,不是錯誤。

App 用戶列表 →

039 個詞條

支付與商業

從「買什麼」到「錢到哪」:通道、意圖、訂單、回呼、發票。

支付通道

payment provider

一家金流的帳號設定(綠界、Stripe…)。同一個 App 可以建多個帳號,並依地區排先後。

支付 →

結帳

checkout

從商品與數量開始的一次收款。回傳的是付款表單欄位或導轉網址,不是「已付款」。

收款:從商品到結帳 →

支付意圖

payment intent

一次收款嘗試的狀態機:建立 → 需要動作 → 成功或失敗。退款與對帳都以它為單位。

支付 →

訂單

order

交易結果。付款成功後才履約:虛擬商品直接完成,實體商品先待出貨、出貨後才算完成。

支付 →

回呼

webhook

金流或平台主動打你的網址通知結果。一定要驗簽,並用事件 id 去重(同一則會重送)。

Webhooks →

退款

refund

對已付款訂單退回金額,可部分退款。退款成功才會回補庫存與優惠券。

支付 →

訂閱

subscription

定期定額收款。支援換方案(立即生效或下期生效)與扣款失敗的催繳流程。

支付 →

電子發票

invoice

綠界 Einv B2C 的開立、查詢、作廢。金鑰與支付分開設定,支付停用不影響已開發票。

發票 →

折讓

allowance

發票開立後的金額調整。退款時可以自動折讓,不必先作廢重開。

發票 →

045 個詞條

檔案、計量與錯誤

檔案怎麼放、用量怎麼算、出錯怎麼認。

檔案路徑

file path

檔案在 App 內的位址(例如 avatars/me.png)。可用前綴管理,也能用路徑直接讀取。

文件托管 →

需授權讀取

gated

只有帶對憑證才讀得到的檔案;公開檔案則任何人拿到網址就能讀。

上傳與讀取檔案 →

計量

metering

公開 API 一律經過計量中介。用量報表與免費額判定都從這裡來,以 UTC 彙總。

冪等鍵

idempotency key

同一把鑰匙重送只會產生一筆結果。重試付款、退款或開票時一定要帶。

錯誤代碼

error code

回應固定是 { error, code }。請用 code 判斷(訊息文字會變),不要比對 error 的字串。

錯誤代碼 →

這裡沒有的詞,代表它還只能從 API 參考 的欄位說明看出來。發現缺漏可以直接回報, 我們會補進下一版。