免 SDK 方案
託管頁面毋須 SDK，任何平台都用得。
POST /v1/sessions 會返回 verification_url。用你產品一貫發送連結嘅方式傳畀申請人——電郵、SMS、App 內重新導向、螢幕上嘅 QR code——ShieldID 就會喺申請人自己部手機上處理拍攝、活體檢測挑戰同自拍。
- 網頁應用程式、原生 App 嘅系統瀏覽器或 WebView、電郵連結或者自助終端機 QR code 都用得——毋須安裝任何嘢
- 合資格方案提供白標品牌，睇落唔似轉交畀第三方
- 結果會經 return_url 重新導向同已簽署嘅 webhook 傳到你度——毋須接駁用戶端回呼
網頁 widget
將流程嵌入你自己嘅頁面。
一段小型 script，會喺你嘅頁面內以 iframe 呈現託管驗證流程，而唔使將申請人帶離你嘅頁面。
現時可用嘅功能
- TLVerify.init({ apiKey, containerId, returnUrl, cancelUrl, webhookUrl, locale, theme }) 會建立 session 並將佢掛載喺你揀嘅元素入面
- 喺你嘅版面內運行同託管頁面一模一樣嘅拍攝流程，並套用你嘅 accentColor 同 logo
- 目前已可以建立 session 並以內嵌方式顯示流程
完成回呼
即將推出onComplete、onCancel、onStep 同自動調整 iframe 大小都屬於小工具介面嘅一部分，但流程入面暫時未有任何操作會觸發佢哋。請唔好建立依賴呢啲事件觸發嘅邏輯，改為使用返回 URL 同 webhook，兩者而家都可以正常使用。
關於在瀏覽器中使用 API 金鑰嘅提示
小工具本身嘅 init() 呼叫，文件說明可以喺客戶端 JavaScript 入面直接接受原始嘅 apiKey。我哋唔建議喺正式環境咁做：任何人查看原始碼都會攞到你嘅金鑰。請改為喺你嘅後端用 POST /v1/sessions 建立 session，再將所得嘅 verification_url 傳俾小工具顯示——建議做法同託管流程一樣，只不過係嵌入而非以連結開啟。
html
<div id="shieldid-verify"></div>
<!-- Exact script URL is published with your API keys; the path below is illustrative. -->
<script src="https://cdn.shieldid.ca/sdk/v1/widget.js"></script>
<script>
// Recommended: create the session on your backend first (see API reference),
// then pass its verification_url straight through — never a raw API key.
TLVerify.init({
containerId: "shieldid-verify",
verificationUrl: "{{ session.verification_url }}", // from your backend
theme: { accentColor: "#0B5CD8" },
});
</script>手機版
原生 SDK 即將推出。
目前未有 iOS 或 Android SDK。喺有之前，請喺你App嘅系統瀏覽器或 WebView 入面開啟託管驗證頁面——呢個同網頁申請人使用嘅流程一樣，而家已經可以用，你嘅App喺邊個平台運行都得。
即將推出原生 iOS 同 Android SDK
揀選整合方式
三種接入方式，坦白比較。
除非你有特別原因要嵌入，否則建議由託管頁面開始。
| 功能 | 託管頁面 | 網頁小工具 | 手機 SDK |
|---|---|---|---|
| 無需 SDK，無需客戶端程式碼 | 是 | 否 | 即將推出 |
| 留喺你自己嘅頁面入面 | 以連結形式開啟 | 嵌入式 iframe | 即將推出 |
| 喺你嘅程式碼入面接收完成回呼 | 返回 URL + webhook | 即將推出 | 即將推出 |
| 你自己嘅品牌 | 適用於合資格方案 | 適用於合資格方案 | 即將推出 |
| 現已可用 | 是 | 是 | 否 |
問題