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

U8API開發(fā)手冊作者：商平鋒版權(quán)所有：用友軟件股份有限公司1.簡介U8API是為U8客戶化應(yīng)用開發(fā)提供的一套標(biāo)準(zhǔn)化的U8ERP業(yè)務(wù)編程接口。是U8UAP二次開發(fā)體系的重要組成部分。它包括一整套涵蓋U8ERP采購、銷售、庫存、制造（規(guī)劃中）、財務(wù)（規(guī)劃中）、基本檔案（規(guī)劃中）等業(yè)務(wù)模塊的API接口資源。U8API的推出為U8標(biāo)準(zhǔn)產(chǎn)品更好的適應(yīng)用戶的個性化需求，更好的實(shí)現(xiàn)客戶化交付提供了有力支持。U8API按照U8ERP業(yè)務(wù)產(chǎn)品模塊進(jìn)行分類，并以U8主要業(yè)務(wù)實(shí)體（單據(jù)、檔案、憑證）作為操作對象，提供了常用的基本操作。比如：對于庫存的收發(fā)單據(jù)，提供“新增”、“審核”、“棄審”、“刪除”、“裝載”、“修改”六個API接口。目前，U8API提供了供應(yīng)鏈采購、銷售、庫存三個產(chǎn)品的所有單據(jù)的增刪改、審核/棄審等API接口，后續(xù)版本會逐步將制造、財務(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資源管理器”中進(jìn)行注冊。U8API還提供了一套運(yùn)行時調(diào)用框架——U8APIBroker。它是所有U8API的調(diào)用代理，用戶要使用某個API只需調(diào)用U8APIBroker即可，無需直接訪問真正的API。U8APIBroker作為一個服務(wù)代理中間件，起到了隔離API的提供者與使用者的作用，降低了耦合依賴關(guān)系。U8API與U8EAI接口從功能上看比較相識，但它們的特性有差別。U8API采用傳統(tǒng)的編程模型，更靠近底層，業(yè)務(wù)邏輯粒度更細(xì)，而且還需要或依賴一些特定的上下文環(huán)境，比如：login、事務(wù)等；而U8EAI接口則是完全松耦合的，采用XML和請求/響應(yīng)的消息傳遞模式，且業(yè)務(wù)粒度比較粗放。這些特性的差別決定了它們的應(yīng)用領(lǐng)域不同，U8API更適合于U8內(nèi)部的功能擴(kuò)展和客戶個性化開發(fā)，而U8EAI則適合外部系統(tǒng)與U8之間以業(yè)務(wù)數(shù)據(jù)交換為特征的應(yīng)用集成開發(fā)。應(yīng)用API總體應(yīng)用過程API瀏覽查找在“開始”->“程序”->“用友ERP-U8”->“UAP”目錄下找到“U8API資源管理器”，單擊，登錄，進(jìn)入“U8API資源管理器”。在左側(cè)“U8API”樹形節(jié)點(diǎn)下，找到某某模塊，如“庫存管理”模塊（可以看到下面列有很多個單據(jù)，如盤點(diǎn)單、采購入庫單等），展開要操作的單據(jù)，分兩個子節(jié)點(diǎn)：“事件”和“服務(wù)接口”，在“服務(wù)接口”下可以看到該單據(jù)提供的API接口，如“添加新單據(jù)”、“審核單據(jù)”等。雙擊這些節(jié)點(diǎn)出現(xiàn)該API的詳細(xì)描述，如下圖所示。在節(jié)點(diǎn)上右鍵單擊彈出“上下文菜單”，在“代碼示例”菜單項(xiàng)上彈出下一級子菜單，單擊它們，如單擊“C#代碼示例”則可以看到調(diào)用該API的C#示例代碼，如下圖所示。直接拷貝這些代碼，然后在集成開發(fā)環(huán)境（IDE）中編輯和編譯這些代碼，即能實(shí)現(xiàn)調(diào)用U8標(biāo)準(zhǔn)API。利用這些代碼示例時，請按照其中每一步驟的提示說明正確操作，如添加必要的引用、按照自動生成的代碼填入正確的參數(shù)等。正確使用則可以調(diào)用成功，否則會返回詳細(xì)的以下代碼中均以C#為例，VB語言請具體查看對應(yīng)的VB代碼示例部分。圖2.SEQ圖表\*ARABIC1接口描述圖代碼示例API調(diào)用過程組件引用針對兩種語言，需要引用不同的組件。C#：%U8SOFT%\Interop\、%U8SOFT%\Interop\、%U8SOFT%\UFMOM\U8APIFramework\、%U8SOFT%\UFMOM\U8APIFramework\、%U8SOFT%\UFMOM\U8APIFramework\如下圖、、所示。（2）VB：%U8SOFT%\UFMOM\U8APIFramework\tlb、%U8SOFT%\UFMOM\U8APIFramework\tlb、%U8SOFT%\UFMOM\U8APIFramework\tlb、添加MicrosoftXML引用如下圖、所示。其中，%U8SOFT%表示U8-872的安裝目錄。圖SEQ圖表\*ARABIC添加對引用圖添加對引用圖添加對U8API框架類庫引用（.dll）圖添加對U8API框架類庫引用(.tlb)圖添加MicrosoftXML引用API調(diào)用添加必要的引用后，可以直接利用自動生成的代碼示例（支持C#和VB兩種語言），結(jié)合API接口詳細(xì)描述，填入必要的參數(shù)值，就可以調(diào)用U8API?？傮w上，對U8API的調(diào)用分成七個步驟：構(gòu)造u8login對象并登陸；構(gòu)造環(huán)境上下文對象，傳入login，并按需設(shè)置其它上下文參數(shù)；設(shè)置API地址標(biāo)識(Url)參數(shù)；構(gòu)造APIBroker；API參數(shù)賦值；調(diào)用API；獲取返回結(jié)果。詳細(xì)的API調(diào)用過程請看下文“API內(nèi)容”中各個模塊中介紹的“開發(fā)步驟”。下面重點(diǎn)介紹幾個關(guān)鍵要點(diǎn)和步驟：環(huán)境上下文、API地址、APIBroker、普通參數(shù)賦值、BO參數(shù)賦值。環(huán)境上下文環(huán)境上下文指在調(diào)用U8API時需要初始化的調(diào)用環(huán)境，包括Login、事務(wù)、特殊的業(yè)務(wù)參數(shù)等。環(huán)境上下文被初始化后，相關(guān)的環(huán)境參數(shù)會被業(yè)務(wù)API使用。U8EnvContextenvContext=newU8EnvContext();Login需要將U8Login對象傳遞給環(huán)境上下文，U8Login對象必須已經(jīng)登錄過。=u8Login;事務(wù)如果需要由外部發(fā)起事務(wù)，則可以發(fā)起事務(wù)的ADOConnection對象傳遞給環(huán)境上下文：conn=newConnectionClass();=conn;同時需要設(shè)置一個外部事務(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在U8API系統(tǒng)中的唯一標(biāo)識，也叫API的URI，調(diào)用API時，需要通過API地址構(gòu)建一個代表此API的Broker對象：U8ApiAddressmyApiAddress=newU8ApiAddress("U8API/PurchaseOrder/VoucherSave");APIBrokerAPIBroker是所有U8API的調(diào)用代理接口。使用U8所有API都必須通過APIBroker間接調(diào)用。APIBroker作為一個服務(wù)代理中間件，起到了隔離API的提供者與使用者的作用，降低了耦合依賴關(guān)系。創(chuàng)建APIBroker必須傳入API地址和環(huán)境上下文：U8ApiBrokerbroker=newU8ApiBroker(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ù)賦值，推薦使用BO對象（BussinessObject）。例如：BusinessObjectDomHead=("DomHead"); =10;2008-09-30ETFrameWork；必須安裝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ù)-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方法參數(shù)：DomHead ——表頭DOM對象domBody ——表體DOM對象strWhere ——過濾條件串varVoucherID ——單據(jù)主表IDstrLocateWhere——定位條件串API上下文：VoucherType——單據(jù)類型，具體類型參看API上下文描述bPositive——紅藍(lán)標(biāo)識：True,藍(lán)字；False,紅字sBillType——為空串sBusType——業(yè)務(wù)類型：普通采購,直運(yùn)采購,受托代銷刪除單據(jù)-Delete方法參數(shù)：DomHead ——表頭DOM對象domBody ——表體DOM對象CurDom ——返回DOM格式錯誤信息API上下文：VoucherType——單據(jù)類型，具體類型參看API上下文描述bPositive——紅藍(lán)標(biāo)識：True,藍(lán)字；False,紅字sBillType——為空串sBusType——業(yè)務(wù)類型：普通采購,直運(yùn)采購,受托代銷新增或修改新單據(jù)-VoucherSave方法參數(shù)：DomHead ——單據(jù)表頭，DOM對象，必輸domBody ——單據(jù)表體，DOM對象，必輸VoucherState ——保存狀態(tài)，必輸。2增加；1修改；0非編輯curID ——返回單據(jù)頭IDCurDom ——返回DOM格式錯誤信息UserMode ——使用模式，0：CS；1:BSAPI上下文：VoucherType——單據(jù)類型，具體類型參看API上下文描述bPositive——紅藍(lán)標(biāo)識：True,藍(lán)字；False,紅字sBillType——為空串sBusType——業(yè)務(wù)類型：普通采購,直運(yùn)采購,受托代銷開發(fā)步驟實(shí)現(xiàn)采購單據(jù)某一功能，主要有以下七個步驟：構(gòu)造u8login對象并登陸聲明和創(chuàng)建u8login類對象前應(yīng)該先引用U8API類庫中的，代碼示例如下：u8Login=new();2008-09以上獲取的行數(shù)是BO對象的實(shí)際行數(shù)。ETFrameWork；必須安裝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上下文描述裝載單據(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，可選DomConfig ——ATO,PTO選配配置，必輸，可設(shè)置為nothingAPI上下文：VoucherType ——單據(jù)類型，必輸。具體類型參看API上下文描述開發(fā)步驟實(shí)現(xiàn)銷售單據(jù)某一功能，主要有以下七個步驟：構(gòu)造u8login對象并登陸聲明和創(chuàng)建u8login類對象前應(yīng)該先引用U8API類庫中的，代碼示例如下：u8Login=new();2008-09以上獲取的行數(shù)是BO對象的實(shí)際行數(shù)。ETFrameWork；必須安裝U8-872版本的庫存管理產(chǎn)品；必須安裝API適配器組件接口說明庫存管理二次開發(fā)接口說明：審核單據(jù)-Audit方法參數(shù)：sVoucherType ——單據(jù)類型：01VoucherId ——單據(jù)IDerrMsg ——錯誤信息cnnFrom ——連接對象(調(diào)用方控制事務(wù)時需要傳入連接對象)TimeStamp ——單據(jù)時間戳(用于檢查單據(jù)是否修改，空串時不檢查)domMsg ——返回DOM格式的信息:主要是可用量信息bCheck ——是否進(jìn)行業(yè)務(wù)檢查(是否控制可用量)bBeforCheckStock——是否檢查可用量bList——傳入falseMakeWheres——傳空sWebXml——傳入空串oGenVouchIds——獲取單據(jù)ID列表(返回審核時自動生成的單據(jù)的id列表,傳空)棄審單據(jù)-CancelAudit方法參數(shù)：sVoucherType ——單據(jù)類型：01VoucherId ——單據(jù)IDerrMsg ——錯誤信息cnnFrom ——連接對象(由調(diào)用方控制事務(wù)時必須傳入)TimeStamp ——單據(jù)時間戳(用于檢查單據(jù)是否修改，空串時不檢查)domMsg ——超可用量提示信息DOM對象(返回DOM格式的信息)bCheck ——是否進(jìn)行業(yè)務(wù)檢查bBeforCheckStock——是否檢查可用量bList——傳入false裝載單據(jù)-Load方法參數(shù)：sVoucherType ——單據(jù)類型：01sWhere ——條件串DomHead ——表頭DOM對象domBody ——表體DOM對象domPos ——貨位DOM對象errMsg ——錯誤信息bGetBlank ——是否獲取空白單據(jù)sBodyWhere_Order——表體排序方式字段注意：其中sWhere設(shè)計(jì)為:如果按單據(jù)號加載，則語法為ccode=N'要加載的單據(jù)號'，例如("sWhere","ccode=N加上N代表存入數(shù)據(jù)庫時以Unicode格式存儲。N'string'表示string是個Unicode字符串Unicode字符串的格式與普通字符串相似，但它前面有一個N標(biāo)識符（N代表SQL-92標(biāo)準(zhǔn)中的國際語言(NationalLanguage)）。N前綴必須是大寫字母。例如，'Michél'是字符串常量而N'Michél'則是Unicode常量。Unicode常量被解釋為Unicode數(shù)據(jù)，并且不使用代碼頁進(jìn)行計(jì)算。Unicode常量確實(shí)有排序規(guī)則，主要用于控制比較和區(qū)分大小寫。為Unicode常量指派當(dāng)前數(shù)據(jù)庫的默認(rèn)排序規(guī)則，除非使用COLLATE子句為其指定了排序規(guī)則。Unicode數(shù)據(jù)中的每個字符都使用兩個字節(jié)進(jìn)行存儲，而字符數(shù)據(jù)中的每個字符則都使用一個字節(jié)進(jìn)行存儲。有關(guān)更多信息，請參見使用Unicode數(shù)據(jù)。Unicode字符串常量支持增強(qiáng)的排序規(guī)則。'0000000001加上N代表存入數(shù)據(jù)庫時以Unicode格式存儲。N'string'表示string是個Unicode字符串Unicode字符串的格式與普通字符串相似，但它前面有一個N標(biāo)識符（N代表SQL-92標(biāo)準(zhǔn)中的國際語言(NationalLanguage)）。N前綴必須是大寫字母。例如，'Michél'是字符串常量而N'Michél'則是Unicode常量。Unicode常量被解釋為Unicode數(shù)據(jù)，并且不使用代碼頁進(jìn)行計(jì)算。Unicode常量確實(shí)有排序規(guī)則，主要用于控制比較和區(qū)分大小寫。為Unicode常量指派當(dāng)前數(shù)據(jù)庫的默認(rèn)排序規(guī)則，除非使用COLLATE子句為其指定了排序規(guī)則。Unicode數(shù)據(jù)中的每個字符都使用兩個字節(jié)進(jìn)行存儲，而字符數(shù)據(jù)中的每個字符則都使用一個字節(jié)進(jìn)行存儲。有關(guān)更多信息，請參見使用Unicode數(shù)據(jù)。Unicode字符串常量支持增強(qiáng)的排序規(guī)則。如果按單據(jù)ID加載，則語法為id=XXX，例如("sWhere","id=1")。刪除單據(jù)-Delete方法參數(shù)：sVoucherType ——單據(jù)類型：01VoucherId ——單據(jù)IDerrMsg ——錯誤信息cnnFrom ——連接對象（由調(diào)用方控制事務(wù)時需要傳入連接對象）TimeStamp ——單據(jù)時間戳domMsg——返回DOM格式的信息：主要是檢查可用量和控制可用量信息bCheck ——是否進(jìn)行業(yè)務(wù)檢查BeforCheckStock ——是否檢查可用量bList ——傳入false添加新單據(jù)-Add方法參數(shù)：sVoucherType ——單據(jù)類型：01DomHead ——表頭DOM對象domBody ——表體DOM對象domPosition ——貨位DOM對象：傳空errMsg ——返回錯誤信息cnnFrom——連接對象，如果由調(diào)用方控制事務(wù)，則需要設(shè)置此連接對象，否則傳空VoucherId ——返回單據(jù)IDdomMsg——返回DOM格式的信息：主要返回可用量和現(xiàn)存量的錯誤信息bCheck ——是否進(jìn)行業(yè)務(wù)檢查(是否控制可用量)bBeforCheckStock ——是否檢查可用量(檢查可用量)bIsRedVouch ——是否紅字單據(jù)sAddedState——傳空字符串bReMote ——是否遠(yuǎn)程修改單據(jù)-Update方法參數(shù)：sVoucherType——單據(jù)類型：01DomHead ——表頭DOM對象domBody ——表體DOM對象domPosition ——貨位DOM對象errMsg ——錯誤信息cnnFrom ——連接對象domMsg ——超可用量提示信息DOM對象（返回DOM格式的信息）bCheck ——是否進(jìn)行業(yè)務(wù)檢查bBeforCheckStock——是否檢查可用量bIsRedVouch ——是否紅字單據(jù)sAddedState ——修改狀態(tài)bUpdateNeedEas ——傳true開發(fā)步驟實(shí)現(xiàn)庫存單據(jù)某一功能，主要有以下七個步驟：構(gòu)造u8login對象并登陸聲明和創(chuàng)建u8login類對象前應(yīng)該先引用U8API類庫中的，代碼示例如下：u8Login=new();2008-09以上獲取的行數(shù)是BO對象的實(shí)際行數(shù)。//獲取BO對象各字段的值。以下代碼示例只取第一行。字段定義詳見API服務(wù)接口定義/******************************以下是必輸字段****************************/intid=(DomHeadRet[0]["id"]);//主關(guān)鍵字段，int類型stringc