結果校驗 API | Silent Auth 繁體中文

介面說明

APP 伺服器端呼叫此介面，將 Engagelab SDK 回傳的加密資料（payload）傳送給 Engagelab 伺服器進行手機號碼一致性校驗。

介面資訊

項目	說明
請求路徑	`POST /v1/verify`
請求協定	HTTPS
認證方式	HTTP Basic Auth
Content-Type	`application/json`

最新網域：authapi.engagelab.com

請求範例

curl -X POST 'https://{authapi.engagelab.com}/v1/verify' \ -H 'Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl' \ -H 'Content-Type: application/json' \ -d '{ "payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..." }'

              
              curl -X POST 'https://{authapi.engagelab.com}/v1/verify' \
  -H 'Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl' \
  -H 'Content-Type: application/json' \
  -d '{
    "payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..."
  }'

此代碼塊在浮窗中顯示

認證方式

使用 HTTP Basic Auth 進行身分認證：

Authorization: Basic base64(appKey:appSecret)

              
              Authorization: Basic base64(appKey:appSecret)

此代碼塊在浮窗中顯示

範例：

appKey: tn4nm0qx032yx6f17q2tsa8f
appSecret: your_app_secret_here
base64 編碼: dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl

Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl

              
              Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl

此代碼塊在浮窗中顯示

請求參數

參數名	類型	必填	說明
payload	string	是	Engagelab SDK 回傳的加密資料，由 APP 透傳

請求主體範例：

{ "payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..." }

              
              {
  "payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..."
}

此代碼塊在浮窗中顯示

回應參數

成功回應（HTTP 200）

參數名	類型	說明
code	int	狀態碼，0 表示成功
msg	string	狀態描述
data	object	回應資料
data.message_id	string	訊息唯一識別碼，可用於問題排查
data.verified	boolean	手機號碼驗證結果，true 表示一致，false 表示不一致

成功範例（驗證通過）：

{ "code": 0, "msg": "success", "data": { "message_id": "1876123456789012345", "verified": true } }

              
              {
  "code": 0,
  "msg": "success",
  "data": {
    "message_id": "1876123456789012345",
    "verified": true
  }
}

此代碼塊在浮窗中顯示

成功範例（驗證不通過）：

{ "code": 0, "msg": "success", "data": { "message_id": "1876123456789012345", "verified": false } }

              
              {
  "code": 0,
  "msg": "success",
  "data": {
    "message_id": "1876123456789012345",
    "verified": false
  }
}

此代碼塊在浮窗中顯示

錯誤回應（HTTP 4xx/5xx）

參數名	類型	說明
code	int	錯誤碼
msg	string	錯誤描述

錯誤範例：

{ "code": 2001, "msg": "auth failed" }

              
              {
  "code": 2001,
  "msg": "auth failed"
}

此代碼塊在浮窗中顯示

錯誤碼說明

錯誤碼	HTTP 狀態碼	說明	處理建議
1000	500	伺服器內部錯誤	請稍後重試，若持續出現請聯絡技術支援
2001	401	認證失敗	檢查 appKey 與 appSecret 是否正確，Authorization 格式是否符合規範
2004	401	appKey 無效	檢查 appKey 是否正確，或聯絡技術支援確認服務是否已開通
3001	400	參數格式錯誤	檢查請求主體是否為合法的 JSON 格式
3002	400	參數校驗失敗	檢查 payload 參數是否存在且格式正確
3003	400	appKey 不匹配	payload 中的 appKey 與認證標頭中的 appKey 不一致，請確保使用正確的金鑰對
3004	400	設定未啟用	服務設定尚未啟用，請聯絡技術支援開通
3005	400	餘額不足	帳戶餘額不足，請儲值後重試
4001	400	設定不存在	未找到對應的服務設定，請聯絡技術支援
5001	400	驗證失敗	電信業者認證過程出現異常，可根據 msg 中的具體資訊排查或聯絡技術支援

注意事項

payload 透傳：APP 收到 Engagelab SDK 回傳的 payload 後，需原樣提交給 APP 伺服器端，再由 APP 伺服器端呼叫本介面，請勿對 payload 進行任何修改。
安全建議：appSecret 請妥善保管，僅在伺服器端使用，請勿在 APP 中暴露。
驗證結果：verified 為 false 表示使用者輸入的手機號碼與 SIM 卡手機號碼不一致，應拒絕使用者登入。