設定 Callback
外部起單是非同步的機制,當透過 SDK 呼叫起單後,會拿到回傳的 Trace Id
,但並不代表就已經起單成功,此時只是進入系統的背景排程等待執行。系統執行的結果有 成功 和 失敗 兩種結果,此時可透過 Callback 機制來取得資訊。
如果你不清楚 Callback 機制是什麼,請先閱讀認識 SDK 的 Callback 機制說明。
外部起單時的 Callback 設定¶
在建立外部起單物件時,可以呼叫 Callback method 並進行參數設定
參數 | 型態 | 說明 |
---|---|---|
CallBackUrl | string | 要 callback 的 api url,如果沒給值則視為不要 callback |
CustomData | string | callback 時要回傳的客製資訊,可不給值 |
例如: 我們希望系統起單成功或失敗後,要主動呼叫 url https://hr-system.com.tw/uofx-sdk/callback
來告知外部系統,並且希望帶有起單當時的時間:
//要 CallBack 的 Url
var url = "https://hr-system.com.tw/uofx-sdk/callback";
//客製資訊: 填入起單時間
var custData = DateTimeOffset.Now.ToString();
//設定 callback
formHelper.Callback(url, custData)
Customdata可以是物件嗎
CustomData 可以是任何物件,只要將其轉成 json 字串即可。