跳轉到

組合 Widget 跳轉網址

如果想提供用戶跳轉至 Cabital Widget 之指定頁面,則需要依下述方法將簽名認證以參數形式帶在網址上。

製作簽名認證網址流程如下:

  1. 於 Widget 基礎網址加上必填參數
  2. 根據欲跳轉的功能加上該功能頁面所需的必填參數
  3. Secret Key 對網址(含參數)進行加密處理
  4. 將第三步結果以參數名 signature 放在網址的最後方
  5. 於瀏覽器輸入組合完成的 Widget 網址

步驟一:於 Widget 基礎網址上加上必填參數

https://connect.cabital.com/api/v1/partner/link

參數 必填 說明
partner_key 合作方的 Access Key
user_ext_ref 合作方提供的帳號 ID
feature 欲跳轉的功能頁面
  • onboarding: 帳號綁定
  • link: 帳號連結
  • kyc: 帳號設定 KYC
  • 2fa: 帳號設定 2FA
  • wallet: 帳戶錢包
  • deposit: 帳戶入金
  • buy: 刷卡買幣
  • convert: 貨幣兌換
  • transfer: 資金轉帳
  • transaction: 單一幣種所有交易列表
  • transaction_detail: 單筆交易詳細資訊
  • withdraw: 帳戶出金

步驟二:根據欲跳轉的功能加上該功能頁面所需的必填參數

功能頁面 feature 必填參數 選填參數
帳號連結 link email:用戶在合作方的帳號 redirect_url:完成連結後自動跳轉的網址
帳號綁定 onboarding email:用戶在合作方的帳號 redirect_url:完成綁定後按鈕可跳轉的網址
用戶實名認證 kyc
帳號設定 2FA 2fa
帳戶錢包 wallet
帳戶入金 deposit
  • method:入金方式
  • major_ccy:入金幣種
  • major_amount:入金金額
刷卡買幣 buy
  • pair:幣種對,買入的加密貨幣-支付的法幣
  • major_ccy:用戶在介面選擇的幣種
  • major_amount:用戶在介面選擇幣種的金額
貨幣兌換 convert
  • pair:兌換的幣種對
  • major_ccy:用戶在介面選擇的幣種
  • major_amount:用戶在介面選擇幣種的金額
資金轉帳 transfer
  • major_ccy:指定轉出幣種
  • major_amount:指定轉出幣種的金額
單一幣種所有交易列表 transaction major_ccy:幣種
單筆交易詳細資訊 transaction_detail txn_id:交易 ID
帳戶出金 withdraw
  • method:出金方式
  • major_ccy:出金幣種
  • major_amount:出金金額

步驟三:加密網址

將基礎網址加上必要參數之網址以 Secret Key 進行 HMAC-SHA256 加密處理,並轉成 Base64 格式後 URL Encode。

可以透過此線上工具協助驗證加密結果

步驟四:將結果以 signature 參數的值加在網址最後

如:https://connect.cabital.com/api/v1/partner/link?partner_key=ccf290ed-ebee-9f87-4b35-cd1c174c90bf&user_ext_ref=cabital_user_1656048062&redirect_url=https%3A%2F%2Fwww.google.com%2F&feature=link&email=demo@partner.com&signature=0rsN8CSfeRHbaRfuGQeqrIcn%2BkEBzImPsEXihLcuGh4%3D

範例說明

合作方資訊

  • Access Keyccf290ed-ebee-9f87-4b35-cd1c174c90bf
  • Secret Key123(此為範例假設值,非實際值)

使用情境

提供用戶跳轉至 Widget 進行 帳號綁定 流程,綁定完成跳轉至 Google 首頁

組合步驟

  1. 帳號綁定功能頁面的基礎網址為:

    https://connect.cabital.com/api/v1/partner/link?feature=link&partner_key=ccf290ed-ebee-9f87-4b35-cd1c174c90bf&user_ext_ref=cabital_user_1656048062

  2. 依據跳轉的功能頁面加上其必填參數,並視情況加上選填參數:
    綁定功能頁面必填參數為 email;希望綁定完成跳轉至 Google 首頁,加上選填參數 redirect_url

    https://connect.cabital.com/api/v1/partner/link?feature=link&partner_key=ccf290ed-ebee-9f87-4b35-cd1c174c90bf&user_ext_ref=cabital_user_1656048062&redirect_url=https%3A%2F%2Fwww.google.com%2F&email=demo@partner.com

  3. 加密網址後並 URL 編碼結果為:

    0rsN8CSfeRHbaRfuGQeqrIcn%2BkEBzImPsEXihLcuGh4%3D

  4. 將加密結果以 signature 參數的值加在網址最後:

    https://connect.cabital.com/api/v1/partner/link?partner_key=ccf290ed-ebee-9f87-4b35-cd1c174c90bf&user_ext_ref=cabital_user_1656048062&redirect_url=https%3A%2F%2Fwww.google.com%2F&feature=link&email=demo@partner.com&signature=0rsN8CSfeRHbaRfuGQeqrIcn%2BkEBzImPsEXihLcuGh4%3D