U8API发手册.docVIP

U8API开发手册 1.简介 “U8API资源管理器”是一个为U8客户化应用开发提供统一的U8API资源查询、访问、调用规范等服务的平台化工具产品。本产品向外提供一套完整统一的标准U8 API调用接口，以便基于U8标准API资源，采用统一编程模型和开发规范，为企业提供应用集成和个性化功能扩展增值服务，打造量体合身的信息系统。 在分类体系上，本产品向外提供的U8 API资源主要按照功能模块以及各个单据进行划分，如库存管理下的盘点单，提供“添加新单据”、“审核单据”、“弃审单据”、“删除单据”、“装载单据”和“修改单据”这样六个标准的API接口，以供客户调用。客户可以在“U8API资源管理器”中查看要调用的API接口描述，同时可以获取调用该API的代码示例（目前支持两种语言C#和VB），客户只需要结合API接口描述并按照代码注释中给出的提示步骤进行操作就可以方便的使用U8 API资源。 下面主要介绍如何使用U8API进行个性化开发，如何对U8API进行调用，同时给出使用过程中需要注意的内容。 2.API应用 API总体应用过程 API查找发现 在U8产品中“UAP”目录下找到“U8API资源管理器”，单击，登录，进入“U8API资源管理器”。在左侧 “U8API” 树形节点下，找到某某模块，如“库存管理”模块（可以看到下面列有很多个单据，如盘点单、采购入库单等），展开要操作的单据，分两个子节点：“事件”和“服务接口”，在“服务接口”下可以看到该单据提供的API接口，如“添加新单据”、“审核单据”等。双击这些节点出现该API的详细描述，如下图2.1所示。在节点上右键单击弹出“上下文菜单”，在“代码示例”菜单项上弹出下一级子菜单，单击它们，如单击“C#代码示例”则可以看到调用该API的C#示例代码，如下图2.2所示。直接拷贝这些代码，然后在集成开发环境（IDE）中编辑和编译这些代码，即能实现调用U8标准API。利用这些代码示例时，请按照其中每一步骤的提示说明正确操作，如添加必要的引用、按照自动生成的代码填入正确的参数等。正确使用则可以调用成功，否则会返回详细的错误信息。 以下代码中均以C#为例，VB语言请具体查看对应的VB代码示例部分。 图2. SEQ 图表 \* ARABIC 1 接口描述 图 2.2 代码示例 API调用过程 组件引用 针对两种语言，需要引用不同的组件。 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的安装目录。 图 SEQ 图表 \* ARABIC 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的调用分成七个步骤： 构造u8login对象并登陆； 构造环境上下文对象，传入login，并按需设置其它上下文参数； 设置API地址标识(Url)参数； 构造APIBroker； API参数赋值； 调用API； 获取返回结果。 详细的API调用过程请看下文“API内容”中各个模块中介绍的“开发步骤”。 BO参数赋值 API参数分两种类型：BO参数和普通参数。BO参数即单据表头或表体类型的参数，普通参数则是非表头表头类型的参数。对BO参数，支持两种方式传入