iT邦幫忙

2021 iThome 鐵人賽

DAY 2
0
永豐金融APIs

永豐Vue一下-從生活尋找靈感系列 第 9

[day9]API就位囉~串接永豐API規劃

##API規劃
先準備這次消費串接的API,主要需要三支API

  • 訂單建置API

    • 目的:
      由網站點選繳費項目,呼叫永豐建立訂單交易API(OrderCreate)

    • 代入參數

      1. 客戶編號(householder:str)
      2. 訂單金額(Amount:int )
        這邊需要注意一下,配合規格,實際送出需要加小數點00,舉例來說:99元,送出的數值為9900才會正常,但為了紀錄方便,程式自動補上小數點後兩位00,此參數還是填入整數金額。
      3. 訂單編號(OrderNo:str)
        訂單編號設計為
           收款方式_+管理費所屬年月+_+訂單成立時之timestamp
      
      1. 收款方式(PayType:str)
        填入A(ATM 轉帳)或C(信用卡)
    • 自動代入

      1. 自填參數一(Param1:str)
        填入客戶編號,永豐API才能回傳客戶資訊。
      2. 自填參數二(Param2:str)
        填入訂單編號(年月),永豐API才能回傳訂單之月份資料。
      3. 自填參數三(Param3:str)
        暫定不填入
      4. 付款截止日期(ExpireDate:str)
        若為ATM付款,設定為訂單成立時的日期+一天,表示須於隔日之前完成匯款動作
      5. 付款截止日期(AutoBilling:str)
        自動請款設定(Y=>自動請款,N=>不自動請款),預設Y
  • 訂單查詢API(以訂單編號查詢)

    • 目的:
      網站發動以訂單編號查詢訂單狀況,即時確認是否已完成訂單,呼叫永豐建立訂單交易API(OrderQuery),此API屬於由商家主動查詢訂單狀態。而OrderPayQuery是永豐主動發動通知,由OrderPayQuery回傳token查詢結果,需要建置服務讓永豐呼叫,待整體架構更完整時再來考慮,暫時不開發此流程。
    • 代入參數
      1. 訂單編號(orderNo:str)
        舉例:A_20210924_1632450255.946536
    • 回傳
      主要需要的回傳參數有兩項
      1. 處理狀態(Status:str)
        確認查詢是否正常(S=>處理成功;F=>處理失敗)
      2. 訂單清單(OrderList:json)
        查詢之訂單資訊
  • 訂單查詢API(以日期查詢)

    • 目的:
      SERVER以日期查詢訂單狀況,主要目的為查詢前兩日訂單,確認各訂單結果,呼叫永豐建立訂單交易API(OrderQuery),並將查詢結果保留於資料庫。
      其中交易日期起迄日配合付款截止日期的兩日設定,固定抓取兩日前的資訊,批次更新訂單資訊。
    • 代入參數
      1. 訂單日期(rundate:str)
        -交易日期起日(DateTimeS:str)
        舉例:20210923
        -交易日期迄日(DateTimeE:str)
        舉例:20210924
    • 回傳
      主要需要的回傳參數有兩項
      1. 處理狀態(Status:str)
        確認查詢是否正常(S=>處理成功;F=>處理失敗)
      2. 訂單清單(OrderList:json)
        查詢之訂單資訊

定義好了,明天就來實作囉


上一篇
[day8]FASTAPI建置示範-進度落後了!!
下一篇
[day10]串接API實測-訂單建置API
系列文
永豐Vue一下-從生活尋找靈感30

尚未有邦友留言

立即登入留言