U8API开发手册作者：商平锋版权所有：用友软件股份有限公司1/28.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 应用2.1. API 总体应用过程 API 浏览查找在“开始” -> “程序” -> “用友 ERP-U8” -> “ UAP”目录下找到“ U8API 资源管理器” ，单击，登录，进入“ U8API 资源管理器” 。
在左侧 “ U8API” 树形节点下，找到某某模块，如“库存管理”模块（可以看到下面列有很多个单据，如盘点单、采购入库单等） ，展开要操作的单据，分两个子节点： “事件”和“服务接口” ，在“服务接口”下可以看到该单据提供的 API 接口，如“添加新单据” 、“审核单据”等双击这些节点出现该 API 的详细描述，如下图 2.1 所示在节点上右键单击弹出“上下文菜单” ，在“代码示例”菜单项上弹出下一级子菜单，单击它们，如单击“ VB 代码示例”则可以看到调用该 API 的 VB 示例代码，如下图 2.2 所示直接拷贝这些代码，然后在集成开发环境（ IDE）中编辑和编译这些代码，即能实现调用 U8 标准 API 利用这些代码示例时，请按照其中每一步骤的提示说明正确操2/28.作，如添加必要的引用、 按照自动生成的代码填入正确的参数等 正确使用则可以调用成功，否则会返回详细的错误信息以下代码中均以 VB为例， C# 语言请具体查看对应的 C#代码示例部分图 2.1 接口描述图 2.2 代码示例3/28. API 调用过程? 组件引用针对两种语言，需要引用不同的组件 1） VB：tlb 、 tlb 、tlb 、添加 Microsoft XML v3.0 引用如下图 2.3 、 2.4 所示。
2） C#： 、、、、如下图 2.5 、 2.6 、 2.7 所示其中， %U8SOFT%表示 U8-872 的安装目录4/28.图 2.3 添加 对 U8API 框架类库引用 (.tlb)图 2.4 添加 Microsoft XML v3.0 引用5/28.图 2.5 添加对 U8Login.dll 引用图 2.6 添加对 引用6/28.图 2.7 添加对 U8API 框架类库引用（ .dll ）7/28.? API 调用添加必要的引用后，可以直接利用自动生成的代码示例（支持 VB 和 C#两种语言），结合 API 接口详细描述，填入必要的参数值，就可以调用 U8 API 总体上，对 U8 API 的调用分成六个步骤：1) 构造 u8login 对象并登陆；2) 构造环境上下文对象，传入login ，并按需设置其它上下文参数；3) 构造 APIBroker ，调用 Connect, 传入 API 地址标识 (Url) 和环境上下文；4) API 参数赋值；5) 调用 API ；6) 获取返回结果详细的 API 调用过程请看下文“ API 内容”中各个模块中介绍的“开发步骤” 。
下面重点介绍几个关键要点和步骤：环境上下文、 API 地址、 APIBroker 、普通参数赋值、 BO参数赋值 环境上下文环境上下文指在调用 U8API 时需要初始化的调用环境，包括 Login 、事务、特殊的业务参数等环境上下文被初始化后，相关的环境参数会被业务 API 使用Dim u8EnvCtx As New U8EnvContextLogin需要将 U8Login 对象传递给环境上下文， U8Login 对象必须已经登录过Set u8EnvCtx. U8Login = ologin事务如果需要由外部发起事务， 则可以发起事务的 ADOConnection 对象传递给环境上下文：Set u8EnvCtx. BizDbConnection = new ADO. Connection ()同时需要设置一个外部事务标记：u8EnvCtx. IsIndependenceTransaction = true特殊业务参数特殊业务参数指调用某些 API 需要设置的特定上下文参数， 比如：销售的 API 必须要设置如 VoucherType 上下文参数，设置方法为：u8EnvCtx. SetApiContext " VoucherType ", 23? API 地址API 地址是指 API 在 U8API 系统中的唯一标识，也叫 API 的 URI，通过该标识唯一确定一个 U8API。
如， API 地址 " U8API/SaleOrder/Save " 代表销售订单中的“新增或修改”这样一个API 接口 APIBrokerAPIBroker 是所有 U8API 的调用代理接口使用 U8 所有 API 都必须通过 APIBroker 间接调用 APIBroker 作为一个服务代理中间件，起到了隔离 API 的提供者与使用者的作用，8/28.降低了耦合依赖关系 调用 API 的时候，需要首先创建一个 APIBroker, 然后调用其 Connect, 传入 API 地址和环境上下文：Dim u8apiBroker As New U8ApiComBrokeru8apiBroker. Connect " U8API/SaleOrder/Save ", u8EnvCtx? 普通参数赋值API 参数分两种类型： BO参数和普通参数。