整合指南

每篇都附可直接複製的範例、需要的憑證,以及「做完會看到什麼」。不知道從哪開始就先讀第一篇。

01學習路線

先選你現在要解決的問題。

路線之間會互相引用,但不需要依序讀完;每一篇都是獨立的。

01

第一次接:先打通,再登入

還沒接過任何 HSystem 接口,或只想先跑通一次完整流程。

終端機能打通 API、Playground 看得到回應,最後做出一個能登入的頁面。

  1. 01第一次呼叫(30 分鐘)終端機印出 {"ok":true}、Playground 看到真正的回應形狀、本機瀏覽器成功送出一次登入請求。難度 入門約 30 分鐘免憑證讀 →
  2. 02OAuth 登入(完整流程)一個按下「登入」就跳去 HSystem、登入完回到你頁面,並把 code 換成 access_token 的 HTML 檔。難度 進階約 30 分鐘免憑證讀 →
  3. 03登入片段一顆能貼進任何網站的「以 HSystem 登入」按鈕,跳頁版與 iframe 版各一份。難度 入門約 15 分鐘免憑證讀 →
  4. 04Callback 片段一個放進 callback.html 的片段:讀出 code、換到 access_token,並把網址清乾淨。難度 入門約 10 分鐘免憑證讀 →
  5. 05用戶資料一個登入後能讀、能寫使用者自訂資料的頁面,不用自己開資料表。難度 中階約 12 分鐘需要憑證 終端用戶 Bearer讀 →
02

讓使用者用 Google 登入

已經有帳號系統,想多一個登入方式;或正在做原生 App。

開一個開關就能用 Google,不必自己申請 Google Client。

  1. 01Google 登入(平台統一)一個「使用 Google 登入」的開關,以及使用者第一次用 Google 登入時的正確預期。難度 入門約 5 分鐘免憑證讀 →
  2. 02原生 App OAuth(Google)一條走得通的原生登入路徑(SDK exchange 或瀏覽器 PKCE),含 pending 補資料的處理。難度 進階約 15 分鐘免憑證讀 →
04

寄驗證碼與通知信

要做註冊驗證、登入驗證,或任何系統通知信。

寄得出 6 位數驗證碼,也寄得出訂單通知信。

  1. 01Email 驗證一個「寄驗證碼 → 使用者輸入 6 位數 → 確認成功」的流程,寄信那段放在你的後端。難度 入門約 10 分鐘需要憑證 App 金鑰讀 →
  2. 02Email 通知一個「寄一封通知信給使用者」的後端呼叫,以及只負責觸發它的前端按鈕。難度 入門約 8 分鐘需要憑證 App 金鑰讀 →
05

收款與上傳檔案

想開始收錢,或需要讓使用者/商品有圖片與檔案。

跑完一次完整結帳(含測試付款),以及一個讀得到的檔案網址。

  1. 01收款:從商品到結帳一次成功的結帳:拿到 orderId 與 checkoutUrl,付款後訂單變成 paid。難度 中階約 25 分鐘需要憑證 App 金鑰或 Bearer讀 →
  2. 02上傳與讀取檔案一個真的能打開的檔案網址(public),以及一條需要授權才讀得到的檔案路徑(gated)。難度 中階約 15 分鐘需要憑證 App 金鑰讀 →
06

上線前後要處理的事

準備上線,或使用者回報「連不上」。

確認連線通了、看得到用戶、法務頁面備好了。

  1. 01Public Ping一次 5 秒就能跑完的健康檢查,確認網路、CORS 與 API 都正常。難度 入門約 5 分鐘免憑證讀 →
  2. 02App 用戶列表(Users API)一份能列出 App 用戶的後台查詢(控制台或 curl),看得出誰有效授權、誰已撤銷。難度 進階約 6 分鐘需要憑證 Dev 控制台讀 →
  3. 03人機驗證一次通過驗證拿到 captcha_ticket,並在註冊或登入請求裡帶上它。難度 中階約 15 分鐘免憑證讀 →
  4. 04法律中心一組在託管登入/同意頁上真的會出現的隱私權政策與服務條款連結(可以一份託管、一份外鏈)。難度 中階約 10 分鐘讀 →

02依服務分類

你接的是哪個服務?

每個服務區塊都說明它解決什麼問題、開始前要準備什麼,以及該讀哪幾篇。

auth

身份驗證

託管登入頁與 REST/SDK 註冊登入、OAuth 授權碼 + PKCE、JWT 存取權杖。

7 篇82 API約 89 分鐘免憑證 · Dev 控制台
  1. 01OAuth 登入(完整流程)一個按下「登入」就跳去 HSystem、登入完回到你頁面,並把 code 換成 access_token 的 HTML 檔。約 30 分鐘
  2. 02登入片段一顆能貼進任何網站的「以 HSystem 登入」按鈕,跳頁版與 iframe 版各一份。約 15 分鐘
  3. 03Google 登入(平台統一)一個「使用 Google 登入」的開關,以及使用者第一次用 Google 登入時的正確預期。約 5 分鐘
  4. 04資料權限(dataScopes 三態)一個欄位三態都設定正確的 App,你知道哪個欄位會讓使用者多一步補資料。約 8 分鐘
  5. 05Callback 片段一個放進 callback.html 的片段:讀出 code、換到 access_token,並把網址清乾淨。約 10 分鐘
  6. 06App 用戶列表(Users API)一份能列出 App 用戶的後台查詢(控制台或 curl),看得出誰有效授權、誰已撤銷。約 6 分鐘
  7. 07原生 App OAuth(Google)一條走得通的原生登入路徑(SDK exchange 或瀏覽器 PKCE),含 pending 補資料的處理。約 15 分鐘
看文件 → 身份驗證 →

03全部指南

照順序排的全部 16 篇。

第一次呼叫(30 分鐘)

終端機印出 {"ok":true}、Playground 看到真正的回應形狀、本機瀏覽器成功送出一次登入請求。

約 30 分鐘讀 →
Public Ping

一次 5 秒就能跑完的健康檢查,確認網路、CORS 與 API 都正常。

約 5 分鐘讀 →
OAuth 登入(完整流程)

一個按下「登入」就跳去 HSystem、登入完回到你頁面,並把 code 換成 access_token 的 HTML 檔。

約 30 分鐘讀 →
登入片段

一顆能貼進任何網站的「以 HSystem 登入」按鈕,跳頁版與 iframe 版各一份。

約 15 分鐘讀 →
Google 登入(平台統一)

一個「使用 Google 登入」的開關,以及使用者第一次用 Google 登入時的正確預期。

約 5 分鐘讀 →
資料權限(dataScopes 三態)

一個欄位三態都設定正確的 App,你知道哪個欄位會讓使用者多一步補資料。

約 8 分鐘讀 →
Callback 片段

一個放進 callback.html 的片段:讀出 code、換到 access_token,並把網址清乾淨。

約 10 分鐘讀 →
App 用戶列表(Users API)

一份能列出 App 用戶的後台查詢(控制台或 curl),看得出誰有效授權、誰已撤銷。

約 6 分鐘 · 需要憑證讀 →
原生 App OAuth(Google)

一條走得通的原生登入路徑(SDK exchange 或瀏覽器 PKCE),含 pending 補資料的處理。

約 15 分鐘讀 →
Email 驗證

一個「寄驗證碼 → 使用者輸入 6 位數 → 確認成功」的流程,寄信那段放在你的後端。

約 10 分鐘 · 需要憑證讀 →
Email 通知

一個「寄一封通知信給使用者」的後端呼叫,以及只負責觸發它的前端按鈕。

約 8 分鐘 · 需要憑證讀 →
用戶資料

一個登入後能讀、能寫使用者自訂資料的頁面,不用自己開資料表。

約 12 分鐘 · 需要憑證讀 →
法律中心

一組在託管登入/同意頁上真的會出現的隱私權政策與服務條款連結(可以一份託管、一份外鏈)。

約 10 分鐘讀 →
收款:從商品到結帳

一次成功的結帳:拿到 orderId 與 checkoutUrl,付款後訂單變成 paid。

約 25 分鐘 · 需要憑證讀 →
上傳與讀取檔案

一個真的能打開的檔案網址(public),以及一條需要授權才讀得到的檔案路徑(gated)。

約 15 分鐘 · 需要憑證讀 →
人機驗證

一次通過驗證拿到 captcha_ticket,並在註冊或登入請求裡帶上它。

約 15 分鐘讀 →

指南只講「怎麼接起來」;單支接口的參數、回應與錯誤,請看 API 參考。 API 參考