SDK 結構

SDK 採用靜態類別 (static) 提供相關的方法 (method)，可以讓開發人員快速的呼叫使用，其結構範例如下:

📜 UofxService
|  ├ [屬性] UofxServerUrl : 站台網址
|  ├ [屬性] Key : 金鑰
|  └─ 📜 BASE : 人員組織模組
|    └─ 📜 Department : 部門模組
|      ├ Create : 新增部門方法
|      ├ Update : 更新部門方法
|      ├ Delete : 刪除部門方法
|      └─ ...

從最上層的根節點 UofxService 開始，此處提供三個 必填 的屬性設定，分別是站台網址、金鑰以及公司代碼，再往下展開其他模組 (例: BASE、BPM) 與其內部的子模組 (例: Department) ，每個模組或子模組皆以 非同步 的方式提供相關的方法，用來跟 UOF X 互動。簡單的程式碼範例如下:

// 設定金鑰
UofxService.Key = "xxx";
// 公司代碼
UofxService.CorpCode = "ede";
// 設定 UOF X 站台網址
UofxService.UofxServerUrl = "https://myuofx.com.tw";

// 呼叫建立部門
await UofxService.BASE.Department.Create(...);

當呼叫 UofxService.BASE.Department.Create 建立部門後，SDK 會接手後面的金鑰驗證、API 呼叫、以及錯誤處理等邏輯。

公司代碼

每個金鑰都只屬於其產生的公司，所以同一把金鑰無法跨公司使用

站台網址

輸入站台網址請勿包含公司代碼，例如公司代碼為 ede，則請勿輸入 https://myuofx.com.tw/ede，正確應輸入 https://myuofx.com.tw