免 SDK 的做法
託管頁面不需要 SDK，適用於任何平台。
POST /v1/sessions 會回傳 verification_url。請以您的產品原本傳送連結的任何方式（電子郵件、簡訊、應用程式內重新導向、螢幕上的 QR code）將其傳給申請人，ShieldID 會在申請人自己的手機上處理拍攝、活體偵測挑戰與自拍。
- 適用於網頁應用程式、原生應用程式的系統瀏覽器或 WebView、電子郵件連結，或自助服務機的 QR code，無需安裝任何東西
- 符合條件的方案提供白標品牌，因此看起來不會像是被轉交給第三方
- 結果會透過 return_url 重新導向與已簽署的 webhook 送達，無需自行串接用戶端回呼
網頁小工具
將流程嵌入您自己的頁面。
一小段指令碼，會在您的頁面中以 iframe 呈現託管的驗證流程，而不是將申請人帶離您的頁面。
目前可用的功能
- TLVerify.init({ apiKey, containerId, returnUrl, cancelUrl, webhookUrl, locale, theme }) 會建立工作階段，並將其掛載到您選擇的元素中
- 在您的版面配置內執行與託管頁面完全相同的拍攝流程，並套用您的 accentColor 與標誌
- 目前已可用於建立工作階段並以內嵌方式顯示流程
完成回呼
即將推出onComplete、onCancel、onStep 以及 iframe 自動調整大小都是小工具介面的一部分，但流程內部目前尚未觸發它們。請不要建置依賴這些事件觸發的邏輯——請改用 return URL 與 webhook,這兩者目前都能正常運作。
關於在瀏覽器中使用 API 金鑰的說明
依文件說明，小工具本身的 init() 呼叫可在用戶端 JavaScript 中接受原始的 apiKey。我們不建議在正式環境這麼做：任何人檢視原始碼都能取得您的金鑰。請改在您的後端以 POST /v1/sessions 建立工作階段，再把產生的 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 | 即將推出 | 即將推出 |
| 您的品牌 | 適用於符合條件的方案 | 適用於符合條件的方案 | 即將推出 |
| 目前即可使用 | 是 | 是 | 否 |
常見問題