U8API開發(fā)手冊(C#版)

1、版權(quán)所有：用友軟件股份有限公司U8API開發(fā)手冊作者：商平鋒1. 簡介U8API是為U8客戶化應(yīng)用開發(fā)提供的一套標(biāo)準(zhǔn)化的U8ERP業(yè)務(wù)編程接口。是U8UAP二次開發(fā)體系的重要組成部分。它包括一整套涵蓋U8ERP 采購、銷售、庫存、制造（規(guī)劃中） 、財(cái)務(wù)（規(guī)劃中） 、基本檔案（規(guī)劃中）等業(yè)務(wù)模塊的 API 接口資源。 U8API 的推出為 U8 標(biāo)準(zhǔn)產(chǎn)品更好的適應(yīng)用戶的個(gè)性化需求，更好的實(shí)現(xiàn)客戶化交付提供了有力支持。U8API按口U8ERP業(yè)務(wù)產(chǎn)品模塊進(jìn)行分類，并以U8主要業(yè)務(wù)實(shí)體（單據(jù)、檔案、憑證）作為操作對象， 提供了常用的基本操作。 比如： 對于庫存的收發(fā)單據(jù)， 提供 “新增” 、“審核”

2、 、 “棄審”、“刪除”、“裝載”、“修改”六個(gè)API接口。目前，U8API提供了供應(yīng)鏈采購、銷售、 庫存三個(gè)產(chǎn)品的所有單據(jù)的增刪改、審核/ 棄審等 API 接口，后續(xù)版本會逐步將制造、財(cái)務(wù)、基本檔案等模塊的 API 納入進(jìn)來。U8API 通過 “ U8API 資源管理器” 對 U8 范圍內(nèi)所有API 進(jìn)行集中統(tǒng)一分類管理， 形成了一套完整的 U8API 資源庫。 U8API 的使用者可以使用“ U8API 資源管理器”瀏覽、查看API及其接口定義，并可輔助進(jìn)行代碼生成（目前支持C#和VB語言）；API的開發(fā)者可以通過此工具發(fā)布、注冊 API,所有業(yè)務(wù)API都必須在“ U8API資源管理器”中

3、進(jìn)行注冊。U8API 還提供了一套運(yùn)行時(shí)調(diào)用框架U8APIBroker。 它是所有 U8API 的調(diào)用代理， 用戶要使用某個(gè) API只需調(diào)用U8APIBroker即可，無需直接訪問真正的 API。U8APIBroker作為 一個(gè)服務(wù)代理中間件，起到了隔離API 的提供者與使用者的作用，降低了耦合依賴關(guān)系。U8API 與 U8EAI 接口從功能上看比較相識，但它們的特性有差別。 U8API 采用傳統(tǒng)的編 程模型， 更靠近底層， 業(yè)務(wù)邏輯粒度更細(xì)， 而且還需要或依賴一些特定的上下文環(huán)境， 比如： login、事務(wù)等；而U8EAI接口則是完全松耦合的，采用XML和請求/響應(yīng)的消息傳遞模式，且業(yè)務(wù)粒度

4、比較粗放。這些特性的差別決定了它們的應(yīng)用領(lǐng)域不同， U8API 更適合于 U8 內(nèi) 部的功能擴(kuò)展和客戶個(gè)性化開發(fā)，而U8EAI則適合外部系統(tǒng)與 U8之間以業(yè)務(wù)數(shù)據(jù)交換為特征的應(yīng)用集成開發(fā)。應(yīng)用2.1. API 總體應(yīng)用過程2.1.1 API 瀏覽查找在“開始”-> “程序”-> “用友ERP-U8 -> “UAP”目錄下找到“ U8API資源管理器”，單擊，登錄，進(jìn)入“ U8API 資源管理器” 。在左側(cè) “ U8API” 樹形節(jié)點(diǎn)下，找到某某模塊，如“庫存管理”模塊（可以看到下面列有很多個(gè)單據(jù)，如盤點(diǎn)單、采購入庫單等） ，展開要操作的單據(jù)，分兩個(gè)子節(jié)點(diǎn)： “事件”和“服務(wù)接

5、口” ，在“服務(wù)接口”下可以看到該單據(jù)提供的 API 接口，如“添加新單據(jù)”、 “審核單據(jù)”等。雙擊這些節(jié)點(diǎn)出現(xiàn)該API 的詳細(xì)描述，如下圖所示。在節(jié)點(diǎn)上右鍵單擊彈出“上下文菜單” ，在“代碼示例”菜單項(xiàng)上彈出下一級子菜單，單擊它們，如單擊“C#（弋碼示例”則可以看到調(diào)用該API的C環(huán)例代碼，如下圖所示。直接拷貝這些代碼，然后在集成開發(fā)環(huán)境（IDE）中編輯和編譯這些代碼，即能實(shí)現(xiàn)調(diào)用U8標(biāo)準(zhǔn)API。利用這些代碼示例時(shí)，請按照其中每一步驟的提示說明正確操作，如添正確使用則可以調(diào)用成功，否則會加必要的引用、按照自動(dòng)生成的代碼填入正確的參數(shù)等。 返回詳細(xì)的錯(cuò)誤信息。以下代碼中均以 C#為例，VB語言

6、請具體查看對應(yīng)的 VB代碼示例部分。ZffCJ病精鼾師j miwram a lwi.嘮巴典衡胃磨i d e - fc i- B M fiM孑件 :* FE省段口E *明注浜醉 aK零富 - i在曜石i添m審中茶般芳竊口描諾B#¥1C : UfiAftn號桑世"F：ImlfiiuHM'AddT*-1晶*:零第士郎一*10刑章<3解 共 &時(shí)拉土生單1 n Jim1，隼細(xì)后3； IE與Tfl孫幻帆曲福S看lt-fr HU出事單 1±產(chǎn)雷品？算 fc«r 0 眼不自濟(jì)呂Ettre±m, T&Sa3JJ*-匕靜a單-t此庭

7、的帙單' U酈街”型髀單-J ft1*餐前燃國白 A Ltiff'* bUtfjfat皂匕噌股昌嘩仁塔中口L5H7科htiXbdLlCUrtLEUDac 面皿2Jh引利由g .£總能卻第wMJXMU»學(xué)雨單VdawF'wih&iff!l： *£二Etwt Db>rt*引用石向聞亞可博濱情便14麻崛U的弦節(jié)E聞MgBMUaMMFlH圖 西.!irsf 工匠每前者f 朝在事叨用Z;7ua草號：乏回事福一%目，-01節(jié)幫:用工工星也 叫臚ktM*的if/W-卻也51也隧5 熱心 IXMtMMDEinrtvU準(zhǔn)引雨至 H1苦哥s t

8、RjdfW占“l(fā)*f日就J售¥7tedr尾受,可明口SjllNtBcKLMriin迫在苦檢.叮布9配樁氏總刖jk但.苦bMbdPiuh晶喜虹*i哨V鶯,圖2.1接口描述5F傳gmin 岬K用*當(dāng)，廣1y丑工 L由*亡點(diǎn)購營空，-4情E君-t± JFffMi- fr ft.« a”件l削口竹國力育五nraft：%»VH m承 WMOkWH 機(jī)機(jī)，麻窯5單擊J颯于Fl,青工竹優(yōu)”5tCH JR ( J 心mu咻日工。門I»q.rv IfCj/m 中"法勒安山桔小E2 Dig省褥其wnmm* 七 0 靖FfWiI I'.rak戶uf

9、twmwf磯citlw*rri dllL I盧中軍才y 羞；EMi Q的福里-巴出口生至學(xué)曰工H 4JI-&Sht5=?土白產(chǎn)比工八月單亡我翱七3亡峭不含母足=匕精生出生聚£白耳亡曬MQ&尊游日上、士現(xiàn)江的區(qū)-產(chǎn)! iMN«ifri t知3單“一: E看年口A l-eiff-已出H#反* L厘*K段,亡本世*色,臺厝厝寓- L措中。- "MJ盤則- 12日就，仔代蝴F£*-W： '1g出!IW”國因1卜tolL.C LL3E< a;(HIM 仙。0 Ml噎手 工*3ii3< EDA 比I flOlIFirun-kria

10、 lAif IMJU 1 ItMJ'lJl Wrvq-hHEil£ IFUrt IP9)：*,工 jy IHZI4-周.TEIZr -e fck J u- Lu ;Ulaht UHk3 an F't l£t m出1 Niniu 門4口 。，工M 由氏電山1"目副用盤帖與啊明修強(qiáng)作HWk.p UiL"id 41lk。卻矩J而訐塘PNl ”迷中，吶UB營J»r卡05中 1. AISLED tfLsCiTi = UH WLd JU L d5LfflD.(l.Ng aI& ； W.如屁 31m3 “xl.國學(xué)I iraf&quo

11、t;SUE"就FlIX d> ，而 4rg 口杯“$ = fi,Urini xIMb - TOiB-ll-j f; a1* i- i 4m*» iH H 口”a i M = *1*圖代碼示例2.1.2 API調(diào)用過程組件引用針對兩種語言，需要引用不同的組件。(1) C#:、U8SOFT%、如下圖、所示。(2) VB:%U8SOFT%UFMOMU8APIFrameworktlb、U8SOFT%UFMOMU8APIFrameworktlb、U8SOFT%UFMOMU8APIFramework tlb、添加Microsoft XML引用如下圖、所示。其中，U8SOFT%I示

12、U8-872的安裝目錄。圖2添加對引用圖添加對引用圖添加對U8API框架類庫引用（.dll）引用-采購管理一2d可用的引用電），F(xiàn)or A.ppli callVisual B&sic runtime Ejects and proiced-ureilVi EualOLE Ant ob ati-oiiUTIDA VS MomServi ceCsmniQiiUTIDA US UBAPIFr i-n ew&rltUTIDA_VS_V6lfl0rAFIJrame'woi-kMicroS£+. XHU v3.0(v8IASIAS加引用直找泊圍(XJ L |11sMi工Fr

13、Mnwwork HEIE：Acrab；1 UFIDA. U8. MomServi ceCommcbit. tlbm WIDA Ue.USAJIFranewQrk tlb口 WLDA. US. WWOHAFIfr iin iff?rk tlb文件名的；文件型型© ：T?；匦虍?|類型庫 休.0lb：歸tlb：機(jī)dll）圖 添加對U8API框架類庫引用（.tlb）圖添加Microsoft XML引用API調(diào)用添加必要的引用后，可以直接利用自動(dòng)生成的代碼示例(支持C糊口 VB兩種語言)，結(jié)合API接口詳細(xì)描述，填入必要的參數(shù)值，就可以調(diào)用U8 API?？傮w上，對U8 API的調(diào)用分成七個(gè)步

14、驟：1) 構(gòu)造u8login對象并登陸；2)構(gòu)造環(huán)境上下文對象，傳入login,并按需設(shè)置其它上下文參數(shù)；3) 設(shè)置API地址標(biāo)識(Url)參數(shù)；4)構(gòu)造 APIBroker;5) API參數(shù)賦值；6) 調(diào)用API;7) 獲取返回結(jié)果。詳細(xì)的API調(diào)用過程請看下文“ API內(nèi)容”中各個(gè)模塊中介紹的“開發(fā)步驟”。下面重點(diǎn)介紹幾個(gè)關(guān)鍵要點(diǎn)和步驟：環(huán)境上下文、API地址、APIBroker、普通參數(shù)賦值、BO參數(shù)賦值。環(huán)境上下文環(huán)境上下文指在調(diào)用U8API時(shí)需要初始化的調(diào)用環(huán)境，包括 Login、事務(wù)、特殊的業(yè)務(wù)參數(shù)等。環(huán)境上下文被初始化后，相關(guān)的環(huán)境參數(shù)會被業(yè)務(wù)API使用。U8EnvContext

15、 envContext = new U8EnvContext();Login需要將U8Login對象傳遞給環(huán)境上下文，U8Login對象必須已經(jīng)登錄過。=u8Login;事務(wù)如果需要由外部發(fā)起事務(wù)，則可以發(fā)起事務(wù)的ADOConnection對象傳遞給環(huán)境上下文：conn = new ConnectionClass();=conn;同時(shí)需要設(shè)置一個(gè)外部事務(wù)標(biāo)記：=true;特殊業(yè)務(wù)參數(shù)特殊業(yè)務(wù)參數(shù)指調(diào)用某些API需要設(shè)置的特定上下文參數(shù)，比如：銷售的 API必須要設(shè)置如VoucherType上下文參數(shù)，設(shè)置方法為：("VoucherType”, 23);API地址API地址是指 API

16、在U8API系統(tǒng)中的唯一標(biāo)識，也叫 API的URI,調(diào)用API時(shí)，需要通過API地址構(gòu)建一個(gè)代表此API的Broker對象：U8ApiAddress myApiAddress = new U8ApiAddress("U8API/PurchaseOrder/VoucherSave");APIBrokerAPIBroker是所有U8API的調(diào)用代理接口。使用 U8所有API都必須通過 APIBroker間接 調(diào)用。APIBroker作為一個(gè)服務(wù)代理中間件，起到了隔離 API的提供者與使用者的作用，降 低了耦合依賴關(guān)系。創(chuàng)建 APIBroker必須傳入API地址和環(huán)境上下文：U8

17、ApiBroker broker = new U8ApiBroker(myApiAddress, envContext);普通參數(shù)賦值A(chǔ)PI參數(shù)分兩種類型：BO參數(shù)和普通參數(shù)。普通參數(shù)是指非單據(jù)表頭表體類型的參數(shù)， 包括基本類型參數(shù)（String、Integer等）、知名對象參數(shù)（Connection、DOMDocument等）。 普通參數(shù)的賦值采用如下方式：("voucherState", 2);BO參數(shù)賦值BO參數(shù)即單據(jù)表頭或表體類型的參數(shù)。對BO參數(shù)，支持兩種方式傳入，一種傳 BO對象，另一種傳DOM對象。以下分別介紹：傳BO對象給BO表頭參數(shù)或表體參數(shù)賦值，推薦使用

18、BO對象（BussinessObject）。例如:BusinessObject DomHead = ("DomHead");=10; 2008-09-30ET FrameWork ;必須安裝U8-872版本的采購管理產(chǎn)品；必須安裝API適配器組件接口說明采購管理二次開發(fā)接口說明：審核單據(jù)-ConfirmPO方法參數(shù)：domHead單據(jù)表頭，DOM對象，必輸API上下文：VoucherType 單據(jù)類型，具體類型參看API上下文描述bPositive紅藍(lán)標(biāo)識：True,藍(lán)字；False紅字sBillType為空串sBusType 業(yè)務(wù)類型：普通采購，直運(yùn)采購，受托代銷棄審單據(jù)

19、-CancelconfirmPO方法參數(shù)：domHead單據(jù)表頭，DOM對象，必輸API上下文：VoucherType 單據(jù)類型，具體類型參看API上下文描述bPositive紅藍(lán)標(biāo)識：True,藍(lán)字；False紅字sBillType為空串sBusType 業(yè)務(wù)類型：普通采購，直運(yùn)采購，受托代銷裝載單據(jù)-Load方法DomHead domBody strWhere varVoucherID表頭DOM對象表體DOM對象過濾條件串單據(jù)主表IDstrLocateWhere定位條件串API上下文：VoucherType bPositive sBillType sBusType單據(jù)類型，具體類型參看AP

20、I上下文描述紅監(jiān)標(biāo)識：True,監(jiān)字 ；False紅子為仝串 業(yè)務(wù)類型：普通采購，直運(yùn)采購，受托代銷刪除單據(jù)-Delete方法DomHead domBody CurDom表頭DOM對象表體DOM對象返回DOM格式錯(cuò)誤信息API上下文:VoucherType bPositive sBillType sBusType單據(jù)類型，具體類型參看API上下文描述紅監(jiān)標(biāo)識：True,監(jiān)字 ；False紅子為仝串 業(yè)務(wù)類型：普通采購，直運(yùn)采購，受托代銷新增或修改新單據(jù)-VoucherSave 方法今奴.DomHead domBody VoucherState curID CurDom UserMode 單據(jù)表

21、頭，DOM對象，必輸單據(jù)表體，DOM對象，必輸保存狀態(tài)，必輸。2增加；1修改；0非編輯返回單據(jù)頭ID返回DOM格式錯(cuò)誤信息 使用模式，0： CS; 1:BSAPI上下文:VoucherType bPositive sBillType sBusType單據(jù)類型，具體類型參看API上下文描述紅監(jiān)標(biāo)識：True,監(jiān)字 ；False紅子為仝串 業(yè)務(wù)類型：普通采購，直運(yùn)采購，受托代銷開發(fā)步驟實(shí)現(xiàn)采購單據(jù)某一功能，主要有以下七個(gè)步驟:1.構(gòu)造u8login對象并登陸聲明和創(chuàng)建u8login類對象前應(yīng)該先引用U8API類庫中的，代碼示例如下：u8Login = new ();2008-09-30GetRes

22、u代("DomHead") as ;以上獲取的行數(shù)是BO對象的實(shí)際行數(shù)。ET FrameWork ;必須安裝U8-872版本的銷售管理產(chǎn)品；必須安裝API適配器組件；接口說明銷售管理二次開發(fā)接口及參數(shù)說明：審核或棄審單據(jù)-Audit方法參數(shù)：domHead單據(jù)表頭，DOM對象，必輸bVerify審核/棄審標(biāo)志，必輸。true表審核；false表?xiàng)墝廇PI上下文：VoucherType單據(jù)類型，必輸。具體類型參看API上下文描述刪除單據(jù)-Delete方法參數(shù)：domHead單據(jù)表頭，DOM對象，必輸API上下文：VoucherType單據(jù)類型，必輸。具體類型參看API上下文描

23、述裝載單據(jù)-Load方法參數(shù)：domHead單據(jù)表頭，DOM對象，必輸domBody單據(jù)表體，DOM對象，必輸VouchID 需要裝載的單據(jù)號，可選blnAuth是否控制權(quán)限：trueAPI上下文：VoucherType單據(jù)類型，必輸。具體類型參看API上下文描述新增或修改單據(jù)-Save方法參數(shù)：domHead單據(jù)表頭，DOM對象，必輸domBody單據(jù)表體，DOM對象，必輸VoucherState保存狀態(tài)，必輸。 0增加；1修改VNewID 單據(jù)的id,可選DomConfigATO,PTCB配配置，必輸，可設(shè)置為nothingAPI上下文：單據(jù)類型，必輸。具體類型參看API上下文描述Vouc

24、herType開發(fā)步驟實(shí)現(xiàn)銷售單據(jù)某一功能，主要有以下七個(gè)步驟：構(gòu)造u8login對象并登陸聲明和創(chuàng)建u8login類對象前應(yīng)該先引用U8API類庫中的，代碼示例如下:u8Login = new （）;2008-09-30GetResu代（"DomHead"） as ;以上獲取的行數(shù)是BO對象的實(shí)際行數(shù)。ET FrameWork ;必須安裝U8-872版本的庫存管理產(chǎn)品；必須安裝API適配器組件接口說明庫存管理二次開發(fā)接口說明： 審核單據(jù)-Audit方法 參數(shù)：sVoucherType單據(jù)類型：01VoucherId單據(jù) IDerrMsg錯(cuò)誤信息cnnFrom連接對象（調(diào)用

25、方控制事務(wù)時(shí)需要傳入連接對象）TimeStamp 單據(jù)時(shí)間戳（用于檢查單據(jù)是否修改，空串時(shí)不檢查domMsg返回DOM格式的信息：主要是可用量信息bCheck是否進(jìn)行業(yè)務(wù)檢查（是否控制可用量）bBeforCheckStock是否檢查可用量bList傳入 falseMakeWheres傳空sWebXml傳入空串idoGenVouchIds獲取單據(jù)ID列表（返回審核時(shí)自動(dòng)生成的單據(jù)的列表，傳空）棄審單據(jù)-CancelAudit方法參數(shù)：sVoucherType VoucherId errMsg單據(jù)類型：01單據(jù)ID錯(cuò)誤信息cnnFrom連接對象（由調(diào)用方控制事務(wù)時(shí)必須傳入 ）TimeStamp 單

26、據(jù)時(shí)間戳（用于檢查單據(jù)是否修改，空串時(shí)不檢查）domMsg 超可用量提示信息 DOM對象（返回DOM格式的信息）bCheck是否進(jìn)行業(yè)務(wù)檢查bBeforCheckStock是否檢查可用量bList傳入 false裝載單據(jù)-Load方法參數(shù)：sVoucherType單據(jù)類型：01sWhere條件串DomHead表頭DOM對象domBody表體DOM對象domPos貨位DOM對象errMsg錯(cuò)誤信息bGetBlank是否獲取空白單據(jù)sBodyWhere_Order表體排序方式字段注意：其中sWhere設(shè)計(jì)為：如果按單據(jù)號加載，則語法為ccode=N'要力口載的單據(jù)號，例如（"sW

27、here","ccode = N'0000000001'"）;如果按單據(jù)ID加載，則語法為id=XXX,仞如（"sWhere", "id = 1"）。刪除單據(jù)-Delete方法sVoucherType VoucherId errMsg cnnFrom象）TimeStamp domMsgbCheck BeforCheckStock bList添加新單據(jù)-Add方法 參數(shù)：sVoucherType-DomHead domBody domPosition errMsg-單據(jù)類型：01單據(jù)ID錯(cuò)誤信息連接對象（由調(diào)用

28、方控制事務(wù)時(shí)需要傳入連接對單據(jù)時(shí)間戳返回DOM格式的信息：主要是檢查可用量和控制 可用量信息是否進(jìn)行業(yè)務(wù)檢查是否檢查PJ用量傳入false單據(jù)類型：01表頭DOM對象表體DOM對象貨位DOM對象：傳空返回錯(cuò)誤信息cnnFrom 連接對象，如果由調(diào)用方控制事務(wù)， 則需要設(shè)置 此連接對象，否則傳空VoucherId返回單據(jù)IDdomMsg返回DOM格式的信息：主要返回可用量和現(xiàn)存 量的錯(cuò)誤信息bCheck是否進(jìn)行業(yè)務(wù)檢查(是否控制可用量)bBeforCheckStock是否檢查引用量(檢查引用量)bIsRedVouch是否紅字單據(jù)sAddedState傳空字符串bReMote是否遠(yuǎn)程修改單據(jù)-Up

29、date方法 參加.sVoucherType一單據(jù)類型：01DomHead表頭DOM對象domBody-表體DOM對象domPosition-貨位DOM對象errMsg一錯(cuò)誤信息cnnFrom-連接對象domMsg-超可用量提示信息 DOM對象(返回DOM格式的信息)bCheck一是否進(jìn)行業(yè)務(wù)檢查bBeforCheckStock一是否檢查可用量bIsRedVouch是否紅字單據(jù)sAddedState修改狀態(tài)bUpdateNeedEas傳 true開發(fā)步驟實(shí)現(xiàn)庫存單據(jù)某一功能，主要有以下七個(gè)步驟：1.構(gòu)造u8login對象并登陸聲明和創(chuàng)建u8login類對象前應(yīng)該先引用U8API類庫中的，代碼示例如下：u8Login = new ();2008-09-30GetResu代("DomHead") as ;以上獲取的行數(shù)是BO對象的實(shí)際行數(shù)。獲取BO對象各字段的值。以下代碼示例只取第一行。字段定義詳見 API服務(wù)接口定義/*以下是必輸字段*/int id = (DomHeadRet0"