T100API設計器使用手冊T產品中心Ver.1.02021/03/12内容摘要API設計器功能使用說明文件資訊文件標題T100API設計器使用手冊預設閱讀對象T100顧問、服務工程師、軟代文件屬性技術文件檔案全名T100API設計器使用手冊(V1.0).docx歷史版本檔版本序號發表時間修編作者修改重點1.02021/03/12Abby建立文件1目錄一、API設計器開發流程.....................................................................................................................................3二、查詢類服務API設計器(adzi700)..............................................................................................................4三、建檔類服務API設計器(adzi710)..............................................................................................................72一、3二、查詢類服務API設計器(adzi700)【功能概述】透過查詢類服務API設計器的設定，自動產生接口服務程式，簡化開發流程與降低開發門檻。【應用場景】欲開發服務類型為”取得ERP資料”的API，且資料來源可透過SQL指令取得。【系統應用】1.執行【整合服務基本資料維護作業azzi700】，查詢服務規格編號為wssp000資料,點擊【修改】按鈕，至【API文件語系清單】頁籤上傳API文件。2.開啟adzi700作業，點擊【新增】按鈕，進行設計資料建檔。2.1.【基本資料】頁籤：API服務基本資料註冊。API服務名稱：輸入API服務名稱。API功能說明：輸入API功能說明。歸屬模組：標準開發選擇輸入WSS模組，客製開發選擇CWSS模組。客製：若為客製開發，請勾選此欄位。服務回傳類型：若該API有使用分包機制，請選擇2.資料分包機制，否則選1.一般單檔回傳。※Q：什麼是資料分包機制？A：避免接收方(服務方)一次回傳發起方筆數太多，資料量過大，而產生傳輸延遲，資料解析等後續種種問題，故而將資料分包(分批)傳送給發起方，詳細運用可參閱”XML分包機制說明”文件。2.2.【請求參數設定】頁籤：Request信息內容設定。項次：流水號自動編號。參數名稱：依序下拉挑選arg1~arg9。詞彙名稱：傳入參數的詞彙名稱。詞彙名稱說明：傳入參數的詞彙名稱說明。ERP欄位編號：傳入參數對應的ERP欄位編號。測試條件值：用於服務驗證時，設定Ruquest傳入的測試值。參數檢查：若有勾選，則檢查傳入參數是否為空值，空值會回傳錯誤：傳入參數不可爲空！。預設值：傳入參數為空時，給予預設值(常數)。輸入範例：1、Y字串組合：搭配SQLWHERE語句欄位有多個條件值時使用(例：pmdn006IN(arg5))，將傳入參數做4字串分割並個別加上單引號。範例：原始字串：s1|s2|s3，則回傳字串：'s1','s2','s3'非必要參數、自定義條件式：兩個欄位需搭配使用，傳入參數不為必要輸入，但當有傳值則需加入當SQL條件做篩選時，請將【非必要參數】勾選，【自定義條件式】輸入SQL條件語句。範例：pmdn001LIKE'%arg2%'詞彙型態：設定傳入參數詞彙型態，數值=numeric、字串=string、日期=date。備註說明：額外補充說明可記錄在此欄位。2.3.【回應參數設定】頁籤：Response信息內容設定。SQL指令：輸入主要邏輯SQL。回傳順序：流水號自動編號。詞彙名稱：回傳參數的詞彙名稱。詞彙名稱說明：回傳參數的詞彙名稱說明。ERP欄位編號：回傳參數對應的ERP欄位編號。資料大小寫：回傳參數的資料大小寫設定。參照格式：回傳參數的顯示是否依資料格式設定，當有勾選時，必須維護【資料格式】欄位。資料格式：輸入欄位顯示的格式。輸入範例：---,---,--&.&&&詞彙型態：設定回傳參數詞彙型態，數值=numeric、字串=string、日期=date。備註說明：額外補充說明可記錄在此欄位。SQL驗證：用於驗證輸入的SQL語句是否語法正確。回應結構設定：XML格式的節點屬性設定，範例如下圖。2.4.【資料分包判斷設定】頁籤：服務回傳類型選擇2.資料分包機制時才會顯示，分包機制設定。3.API設計資料建檔完成後，於【工具】執行【重新產生服務程式】，提示”服務程式wssp000重產成功”即代表開發完成，可進入測試驗證階段。56三、建檔類服務API設計器(adzi710)【功能概述】透過建檔類服務API設計器的設定，自動產生接口服務程式，簡化開發流程與降低開發門檻。【應用場景】欲開發全新的API程式，且服務類型為”建立ERP資料”。【系統應用】1.執行【整合服務基本資料維護作業azzi700】進行API服務註冊。2.開啟adzi710作業，點擊【新增】按鈕，進行設計資料建檔。2.1.【基本資料】頁籤：API服務名稱輸入或開窗挑選於azzi700作業建立的WS服務名稱。2.2.【請求參數節點設定】頁籤：Request信息節點內容設定，如下範例。7XML格式JSON格式2.3.【應用元件設定】頁籤：呼叫元件名稱設定。範例：s_apmt520_ws_confirm※若元件有傳入參數或回傳參數，請於重產服務程式後，下載程式自行於該元件程式段補入。確認應用元件編號：若程式需要呼叫確認段元件，請維護此欄位。過帳應用元件編號：若程式需要呼叫過帳段元件，請維護此欄位。交易前元件編號：在事務(Transaction)開始前需要呼叫SUB元件，請維護此欄位。交易後元件編號：在事務(Transaction)結束後需要呼叫SUB元件，請維護此欄位。更新狀態後元件編號：在更新單據狀態碼後需要呼叫SUB元件，請維護此欄位。2.4.【請求參數設定】頁籤：Request信息內容設定。項次：流水號自動編號。歸屬節點名稱：傳入參數對應的節點名稱。詞彙名稱：傳入參數的詞彙名稱。詞彙名稱說明：傳入參數的詞彙名稱說明。ERP欄位編號：傳入參數對應的ERP欄位編號。傳值允許為空：傳入參數是否檢查允許為空。預設值：傳入參數為空時，給予預設值(可以是變數、常數、function)。輸入範例：g_site、”1”、”Y”、cl_get_current()參數檢查：傳入參數是否檢查資料合理性。當有勾選時，必須選擇【檢查方式】欄位。檢查方式：1：r.v(僅提供1.檢查存在)：傳入參數需r.v校驗帶值檢查。※若r.v有參數設定，請於重產服務程式後，下載程式自行維護g_chkparam.*的參數。範例：LETg_chkparam.arg1=g_site2：單別檢查：傳入參數檢查單別正確性。(程式呼叫元件：s_aooi200_chk_slip)3：數值檢查：傳入參數是否介於特定範圍內。(程式呼叫元件：cl_ap_chk_range)4：關帳日檢查：傳入參數是否小於等於關帳日期。(程式呼叫元件：s_date_chk_close)校驗值：當檢查方式為1、2、3時，校驗值為必要輸入。1：輸入校驗帶值型態=1.檢查存在的識別碼。輸入範例：v_pmdsdocno2：輸入檢查的單別。輸入範例：apmt5603：輸入數值檢查範圍。輸入範例：1,100詞彙型態：設定傳入參數詞彙型態，數值=numeric、字串=string、日期=date。備註說明：額外補充說明可記錄在此欄位。2.5.【回應參數設定】頁籤：Response信息內容設定。項次：流水號自動編號。詞彙名稱：回傳參數的詞彙名稱。8詞彙名稱說明：回傳參數的詞彙名稱說明。ERP欄位編號：回傳參數對應的ERP欄位編號。參照格式：回傳參數的顯示是否依資料格式設定，當有勾選時，必須維護【資料格式】欄位。資料格式：輸入欄位顯示的格式。輸入範例：---,---,--&.&&&詞彙型態：設定回傳參數詞彙型態，數值=numeric、字串=string、日期=date。備註說明：額外補充說明可記錄在此欄位。3.API設計資料建檔完成後，於【整單操作】執行【產生服務程式】，即可自動產生服務程式，提示”服務程式重產成功”即代表服務程式碼已產生成功。※因重產程式會將人工開發的程式覆蓋，執行時請特別注意，避免程式碼遺失。4.至T100設計器下載程式，進行ERP邏輯處理撰寫。9
