跳轉到主要內容
本文件提供使用 Fluz Gift Card Vendor API Connector 且以 Runa 作為供應商時的特定細節。

原生 Runa API 與 Fluz API Adapter 比較

Base URL

驗證機制

Runa Base URL
  • 透過 API Key Authentication,使用 X-Api-Key 標頭

Fluz API Adapter

  • 使用 Basic Authentication,於 Authorization 標頭中提供(與所有 vendor 整合相同)。

API 端點比較

請求範例

建立訂單

原生 Runa 請求:

Fluz API Adapter 請求:

Runa 訂單的背景處理

透過 Runa 整合進行的所有購買操作皆以背景作業方式處理。Fluz API Adapter 為 Runa 提供兩種回應模式:

同步與非同步處理模式

  • 同步模式:
    • 加上標頭 X-Execution-Mode: sync 以等待背景作業完成
    • API 呼叫會等待直到背景購買作業完成
    • 回應中會返回完整的作業結果
    • 適合測試情境,但複雜購買可能會發生逾時
  • 非同步模式(預設):
    • 立即回應一個作業參考 ID
    • 購買會在背景持續處理
    • 之後可使用該參考 ID 查詢訂單端點以檢查狀態
    • 建議用於生產環境以避免逾時
兩種模式都依賴背景處理,但在 API 對客戶端的回應方式上有所不同。

冪等性支援

原生 Runa API 與 Fluz 的實作皆支援冪等性鍵以防止重複操作:

使用 cURL 的範例

範例 1:取得特定訂單

範例 2:取得所有訂單

範例 3:取得所有幣別的餘額

範例 4:取得 USD 幣別的餘額

範例 5:建立訂單(非同步模式 - 預設)

範例 6:建立訂單(同步模式)