U8API开发手册
*******
版权所有：用友软件股份有限公司
1.简介
U8API是为U8客户化应用开发提供的一套标准化的U8ERP业务编程接口。是U8UAP二次开发体系的重要组成部分。它包括一整套涵盖U8ERP采购、销售、库存、制造（规划中）、财务（规划中）、基本档案（规划中）等业务模块的API接口资源。U8API的推出为U8标准产品更好的适应用户的个性化需求，更好的实现客户化交付提供了有力支持。
U8API按照U8ERP业务产品模块进行分类，并以U8主要业务实体（单据、档案、凭证）作为操作对象，提供了常用的基本操作。比如：对于库存的收发单据，提供“新增”、“审核”、“弃审”、“删除”、“装载”、“修改”六个API接口。目前，U8API提供了供应链采购、销售、库存三个产品的所有单据的增删改、审核/弃审等API接口，后续版本会逐步将制造、财务、基本档案等模块的API纳入进来。
U8API通过“U8API资源管理器”对U8范围内所有API进行集中统一分类管理，形成了一套完整的U8API资源库。U8API的使用者可以使用“U8API资源管理器”浏览、查看API及其接口定义，并可辅助进行代码生成（目前支持C#和VB语言）；API的开发者可以通过此工具发布、注册API，所有业务API都必须在“U8API资源管理器”中进行注册。
U8API还提供了一套运行时调用框架——U8APIBroker。它是所有U8API的调用代理，用户要使用某个API只需调用U8APIBroker即可，无需直接访问真正的API。U8APIBroker作为一个服务代理中间件，起到了隔离API的提供者与使用者的作用，降低了耦合依赖关系。
U8API与U8EAI接口从功能上看比较相识，但它们的特性有差别。U8API采用传统的编程模型，更靠近底层，业务逻辑粒度更细，而且还需要或依赖一些特定的上下文环境，比如：login、事务等；而U8EAI接口则是完全松耦合的，采用XML和请求/响应的消息传递模式，且业务粒度比较粗放。这些特性的差别决定了它们的应用领域不同，U8API更适合于U8内部的功能扩展和客户个性化开发，而U8EAI则适合外部系统与U8之间以业务数据交换为特征的应用集成开发。
2.API应用
.1.API总体应用过程
2.1.1API浏览查
在“开始”->“程序”->“用友ERP-U8”->“UAP”目录下到“U8API资源管理器”，单击，登录，进入“U8API资源管理器”。在左侧 “U8API” 树形节点下，到某某模块，如“库存管理”模块（可以看到下面列有很多个单据，如盘点单、采购入库单等），展开要操作的单据，分两个子节点：“事件”和“服务接口”，在“服务接口”下可以看到该单据提供的API接口，如“添加新单据”、“审核单据”等。双击这些节点出现该API的详细描述，如下图2.1所示。在节点上右键单击弹出“上下文菜单”，在“代码示例”菜单项上弹出下一级子菜单，单击它们，如单击“C#代码示例”则可以看到调用该API的C#示例代码，如下图2.2所示。直接拷贝这些代码，然后在集成开发环境（IDE）中编辑和编译这些代码，即能实现调用U8标准API。利用这些代码示例时，请按照其中每一步骤的提示说明正确操作，如添加必要的引用、按照自动生成的代码填入正确的参数等。正确使用则可以调用成功，否则会返回详细的错误信息。
以下代码中均以C#为例，VB语言请具体查看对应的VB代码示例部分。
图2.1 接口描述
图 2.2 代码示例
2.1.2API调用过程
组件引用
针对两种语言，需要引用不同的组件。
(1)C#：
%U8SOFT%\Interop\Interop.U8Login.dll、
%U8SOFT%\Interop\Interop.MSXML2.dll、%U8SOFT%\UFMOM\U8APIFramework\UFIDA.U8.U8APIFramework.dll、%U8SOFT%\UFMOM\U8APIFramework\UFIDA.U8.MomServiceCommon.dll、%U8SOFT%\UFMOM\U8APIFramework\UFIDA.U8.U8MOMAPIFramework.dll
如下图2.3、2.4、2.5所示。
（2）VB：
%U8SOFT%\UFMOM\U8APIFramework\UFIDA.U8.U8APIFramework. tlb、%U8SOFT%\UFMOM\U8APIFramework\UFIDA.U8.MomServiceCommon. tlb、%U8SOFT%\UFMOM\U8APIFramework\UFIDA.U8.U8MOMAPIFramework. tlb、
添加Microsoft XML v3.0引用
如下图2.6、2.7所示。
其中，%U8SOFT%表示U8-872的安装目录。
图 2.3 添加对U8Login.dll引用
图 2.4 添加对Interop.MSXML2.dll引用
图 2.5 添加对U8API框架类库引用（.dll）
图2.6 添加对U8API框架类库引用(.tlb)
图2.7 添加Microsoft XML v3.0引用
API调用
添加必要的引用后，可以直接利用自动生成的代码示例（支持C#和VB两种语言），结合API接口详细描述，填入必要的参数值，就可以调用U8 API。
总体上，对U8 API的调用分成七个步骤：
1)构造u8login对象并登陆；
2)构造环境上下文对象，传入login，并按需设置其它上下文参数；
3)设置API地址标识(Url)参数；
4)构造APIBroker；
5)API参数赋值；
6)调用API；spring framework表达式assign
7)获取返回结果。
详细的API调用过程请看下文“API内容”中各个模块中介绍的“开发步骤”。
下面重点介绍几个关键要点和步骤：环境上下文、API地址、APIBroker、普通参数赋值、BO参数赋值。
✓环境上下文
环境上下文指在调用U8API时需要初始化的调用环境，包括Login、事务、特殊的业务参数等。环境上下文被初始化后，相关的环境参数会被业务API使用。
U8EnvContext envContext = new U8EnvContext();
●Login
需要将U8Login对象传递给环境上下文，U8Login对象必须已经登录过。
envContext.U8Login = u8Login;
●事务
如果需要由外部发起事务，则可以发起事务的ADOConnection对象传递给环境上下文：
ADODB.ConnectionClass conn = new ConnectionClass();
envContext.BizDbConnection = conn;
同时需要设置一个外部事务标记：
envContext.IsIndependenceTransaction = true;
●特殊业务参数
特殊业务参数指调用某些API需要设置的特定上下文参数，比如：销售的API必须要设置如VoucherType上下文参数，设置方法为：
envContext.SetApiContext("VoucherType", 23);
✓API地址
API地址是指API在U8API系统中的唯一标识，也叫API的URI，调用API时，需要通过API地址构建一个代表此API的Broker对象：
U8ApiAddress myApiAddress = new U8ApiAddress("U8API/PurchaseOrder/VoucherSave");
✓APIBroker
APIBroker是所有U8API的调用代理接口。使用U8所有API都必须通过APIBroker间接调用。APIBroker作为一个服务代理中间件，起到了隔离API的提供者与使用者的作用，降低了耦合依赖关系。创建APIBroker必须传入API地址和环境上下文：
U8ApiBroker broker = new U8ApiBroker(myApiAddress, envContext);
✓普通参数赋值
API参数分两种类型：BO参数和普通参数。普通参数是指非单据表头表体类型的参数，包括基本类型参数（String、Integer等）、知名对象参数（Connection、DOMDocument等）。普通参数的赋值采用如下方式：
broker.AssignNormalValue("voucherState", 2);
✓BO参数赋值
BO参数即单据表头或表体类型的参数。对BO参数，支持两种方式传入，一种传BO对象，另一种传DOM对象。以下分别介绍：
●传BO对象
给BO表头参数或表体参数赋值，推荐使用BO对象（BussinessObject）。
例如：
    BusinessObject DomHead = broker.GetBoParam("DomHead");
    DomHead.RowCount = 10; //设置行数，不设置也可
    //给BO对象的字段赋值，值可以是真实类型，也可以是无类型字符串
    //以下代码示例只设置第一行值。各字段定义详见API服务接口定义
    /****************************** 以下是必输字段****************************/
    DomHead[0]["poid"] = ""; //主关键字段，int类型
    DomHead[0]["dpodate"] = ""; //日期，DateTime类型
    DomHead[0]["cpoid"] = ""; //订单编号，string类型
……
    /***************************** 以下是非必输字段****************************/
    DomHead[0]["ipresent"] = ""; //现存量，string类型
    DomHead[0]["cmaketime"] = ""; //制单时间，DateTime类型
    DomHead[0]["cmodifytime"] = ""; //修改时间，DateTime类型
……
在此种情况下U8 API框架会对BO对象各字段进行参数校验。对字段进行赋值时，值可以是真实类型，也可以是无类型字符串。
●传DOM对象
给BO表头参数或表体参数赋值，也支持直接传入DOM对象（DOMDocument）。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。