開發者文件/API 參考

API 概述

在整合之前了解目前的私有預覽合約、身分驗證模型、冪等性和證據期望。

狀態私有預覽
適用對象工程、解決方案架構師
負責團隊UWAY 工程團隊
審核日期2026-08-02

契約狀態

目前的 API 是一個以實現為主導的私有預覽版。 UWAY 在開戶期間提供租戶基本 URL、憑證、啟用的操作、回調配置和生產合約。

本文件中的範例描述了用於整合規劃的合約草案。它們不得被視為公共自助服務端點可用的確認。

協議約定

公約目前的預覽方法
交通HTTPS
資料欄位JSON
時間UTC 格式的 ISO 8601
認證租戶持有者憑證
冪等性每個邏輯寫入請求的穩定密鑰
可追溯性UWAY 參考號碼加上客戶交易或案件 ID
錯誤HTTP 狀態加上結構化錯誤對象

認證

將憑證保存在伺服器端秘密管理器中。不要在瀏覽器程式碼、行動應用程式、用戶端分析、原始碼控制或螢幕截圖中公開它們。

Authorization: Bearer YOUR_TENANT_KEY
Content-Type: application/json
Idempotency-Key: txn_8f72b1c4e5d9

冪等性

在逾時或不確定回應後重試一個邏輯請求時,請使用相同的冪等性金鑰。僅當業務操作本身是新的時才產生新密鑰。

將冪等性金鑰、UWAY 引用和業務事務或個案識別碼保留在一起。

證據與日誌

記錄請求時間、租戶、操作、業務參考、回應狀態、UWAY參考、設定版本和錯誤碼。請勿將原始憑證或不必要的敏感客戶資料放入應用程式日誌中。

後續步驟