跳至主要內容
ShieldID

開發者

身分驗證 API 文件，為實際使用而設。

一個 REST API、一個俾你唔想自己開發嘅部分使用嘅託管頁面，加上已簽署嘅 webhook，結果一出就即時知道。Sandbox 金鑰永不收費，所以了解 ShieldID 最快嘅方法就係直接呼叫佢。

喺 sandbox 免費開始閱讀快速入門

五分鐘速覽

四個呼叫，一個思維模型。

呢份文件入面其他內容，都係喺呢個循環上嘅細節補充。

  1. 建立工作階段

    POST /v1/sessions，附上返回 URL 同 webhook URL。你會攞到 session_id 同 verification_url。

  2. 交俾申請人

    將 verification_url 當連結發送，或者等佢哋掃描桌面版託管頁面顯示嘅 QR 碼。佢哋喺自己部手機上完成。

  3. 接收已簽署嘅 webhook

    當 session 去到 VERIFIED 或 FAILED，ShieldID 會將結果 POST 去你嘅 webhook URL，並加上簽署，等你可以確認係來自我哋。

  4. 讀取結果

    可以信任 webhook，或者自己呼叫 GET /v1/sessions/{id}/result。無論點樣，你攞到嘅都係逐項檢查嘅結果，而唔係一個不透明嘅分數。

試用

建立你第一個 session。

以三種語言寫成嘅相同請求。這就是概念模型第一步所描述嘅呼叫。

bash
# Create a verification session (sandbox keys are never billed)
curl -X POST https://api.shieldid.ca/v1/sessions \
  -H "X-Api-Key: vk_sand_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "return_url": "https://yourapp.example/verified",
    "webhook_url": "https://yourapp.example/hooks/shieldid"
  }'

# → { "session_id": "…", "verification_url": "https://…/v/…", "environment": "sandbox" }

Sandbox 金鑰 (vk_sand_…) 可以免費運行完全相同嘅流程。轉用 vk_live_ 金鑰後，除咗發票之外，其他一概不變。

找到入門之路

其餘嘅開發者文件。

共六頁。睇你需要嘅就得。

API 參考

每個端點、每個欄位、每種可預先規劃嘅錯誤。
開啟 API 參考

快速入門

由 sandbox 金鑰到第一個已簽署 webhook，按次序講解。
開啟 快速入門

SDKs

網頁小工具、託管流程，以及未來計劃。
開啟 SDKs

Sandbox

簽約之前,先完整測試成個流程。

sandbox 金鑰(前綴 vk_sand_)運行嘅 API、託管頁面同 webhook 流程,同正式環境完全一樣。所有顯示 session 嘅地方都會標記 environment: "sandbox",而 sandbox session 無論任何方案都唔會收費。

閱讀 sandbox 指南
  • 建立真實 session,用你自己部手機驗證真實文件,收返真實嘅已簽署 webhook
  • 你喺 sandbox 做嘅任何操作都唔會影響發票
  • 只需更換金鑰前綴就可以轉用正式環境,請求格式維持不變

公開透明地開發

邊啲已經完成,邊啲仲未。

我哋寧願預先話你知,都好過等你喺整合途中先發現。

網頁 widget 完成回呼

即將推出

onComplete、onCancel 同 onStep 目前已存在於 widget 嘅介面,但暫時未有任何機制會觸發佢哋。請使用返回 URL 同 webhook,兩者而家都可以正常運作。

強制執行嘅速率限制

即將推出

每個 API 金鑰都有按你嘅方案記錄嘅速率限制,但請求方面暫時未強制執行,所以請自行規劃,唔好依賴 ShieldID 為你限流。

自助註冊 sandbox

即將推出

自助註冊功能開發期間,sandbox 金鑰會按要求發出。只要你提出,我哋會盡快處理。

問題

為開發人員提供直接嘅答案。

立即開始

一個下午就可以上線。

先用 sandbox 金鑰,喺自己部手機上行一次驗證,再睇睇佢發俾你嘅 webhook。毋須聯絡銷售。

喺 sandbox 免費開始閱讀快速入門

Sandbox 工作階段永不收費。