HSystem API
API Reference
已上線服務的 OpenAPI 路徑索引。完整合併規格可下載 openapi.json。
身份驗證
託管登入頁與 REST／SDK 註冊登入、OAuth 授權碼 + PKCE、JWT 存取權杖。
40 個端點
用戶資料快取
以 App + 用戶為鍵的 JSON 資料快取。寫入合併指定的鍵。允許的鍵留空時不限制鍵名與型別；有清單時才依宣告檢查。已授權的聯絡方式仍從帳號投影。
3 個端點
Email 驗證碼與確認歸屬；含一般通知寄送（模板或 HTML）。
3 個端點
手機驗證
以 SMS OTP 確認手機號碼（Twilio Verify）。
尚無 OpenAPI 路徑
人機驗證
人機驗證：網頁 widget（Turnstile／reCAPTCHA v3／Altcha／Cap／mCaptcha 單選）與應用程序圖片挑戰 API；Auth 僅掛載觸發條件。
尚無 OpenAPI 路徑
支付
開發者向終端用戶收款（BYOK，非平台代收）。建議商品結帳 POST /v1/pay/checkout（items[] 多品）；薄收款 intents；開放式 Provider Registry（stub／Stripe 骨架，可掛更多通道）。出站事件請用「Webhooks」服務。
尚無 OpenAPI 路徑
文件托管
任意檔案上傳、路徑／前綴管理、內容去重與公開／私密讀取。控制台預設 console/* 資產前綴。
尚無 OpenAPI 路徑
商品
管理 App 內商品型錄：實體／虛擬／方案／服務／普通物品；支援 Tag 分類、規格、選配、綁定文件與自訂 JSON。目錄幣別的金額用 dinero.js 的最小單位。地區價格先用 Frankfurter 匯率換算，再加百分比或固定偏移。新建預設下架。公開型錄：GET /v1/commerce/apps/{appId}/…；管理 CRUD（App Secret）：/v1/commerce/products|tags。結帳見「支付」（多品 items[]）；用戶背包見「用戶物品」；折扣與邀請碼見「碼」。
尚無 OpenAPI 路徑
碼
統一管理折扣碼、商品兌換碼、渠道歸因碼，以及註冊邀請碼。兌換／領券事件請訂閱「Webhooks」服務。
尚無 OpenAPI 路徑
用戶物品
托管終端用戶背包（購買／兌換／App 代發）。API：GET /v1/inventory/items|entitlements、POST …/consume、DELETE …/items/:id；App Secret：POST /v1/inventory/grant、PATCH …/items/:id。設定 allowAppGrant／allowUserConsume 控制寫入。
尚無 OpenAPI 路徑
條款與政策
產生並託管隱私權政策、服務條款等文件；提供公開 URL 與匯出。
4 個端點
訪客
免註冊訪客身份：每 App 專屬 guest pool，與 Auth 正式池分離。可設定服務白名單、session／refresh 壽命；refresh／logout 與 Auth 共用。升級後同一 user id 遷入正式池。
尚無 OpenAPI 路徑
Webhooks
把登入、付款、兌換等事件送到你的後端、Discord 或 Slack。金流公司打回來的回呼網址在支付。
尚無 OpenAPI 路徑
好友
App 內好友關係：搜尋、邀請／直加、名單與顯示欄位。
尚無 OpenAPI 路徑