当前位置：首页 > article >正文

测试金蝶云的OpenAPI

article 2025/3/4 6:06:54

如何使用Postman测试K3Cloud的OpenAPI

1. 引言

在本篇博客中，我将带你逐步了解如何使用Postman测试和使用K3Cloud的OpenAPI。内容包括下载所需的SDK文件、配置文件、API调用及测试等步骤。让我们开始吧！

2. 下载所需的SDK文件

2.1 获取SDK

首先，确保你下载了适用于你平台的SDK文件。你可以从K3Cloud官方API文档页面下载所需的SDK。

访问OpenAPI部分。
根据你的需求下载Java、PHP、Python等平台的SDK。

以下是从K3Cloud文档页面下载SDK的示例：

在这里插入图片描述
下载完成以后解压，并且阅读SDK使用说明文件，主要是申请第三方登录授权。

3. 配置SDK

3.1 编辑`kdwebapi.properties`文件

下载完SDK后，下一步是进行正确配置。打开kdwebapi.properties文件，你需要配置一些参数，如服务器地址、API密钥、认证凭证等，这些信息都需要根据你所在的K3Cloud实例来设置。

服务器地址：确保这个地址指向你的K3Cloud实例。
API密钥：你需要通过K3Cloud的授权门户申请密钥。

在这里插入图片描述

4. 在Postman中测试API

4.1 如何通过Postman测试登录接口

操作步骤如下：

打开Postman。
设置登录接口：
- API URL：http://localhost/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.AuthService.ValidateUser.common.kdsvc
- 请求参数：输入必要的字段，如数据中心ID、用户名和密码，采用JSON格式。

示例：

{"parameters":["数据中心ID","用户名","密码","2052"]}

在这里插入图片描述
点击发送按钮获取响应。

4.2 查询元数据

为了获取数据，你需要使用以下API URL：

http://localhost/k3cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.QueryBusinessInfo.common.kdsvc

输入所需的查询参数，例如表单ID，具体的请求格式可以参考API文档。

示例：

{"parameters":[{"FormId":"BD_BANK"}]}

在这里插入图片描述
表单ID可以查看API文档。

4.3 查询单据

为了获取数据，你需要使用以下API URL：

http://localhost/k3cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.ExecuteBillQuery.common.kdsvc

输入所需的查询参数，例如表单ID、查询的字段集合等，具体的请求格式可以参考API文档。查询的字段集合可以在获取的元数据中查看。
在这里插入图片描述
示例：

{
    "parameters":[{
        "FormId":"BD_BANK"
        ,"FieldKeys":"FNumber,FDescription,FCreateDate"
        ,"Limit":2000
        ,"TopRowCount":0
        ,"StartRow":0
        ,"FilterString":""
        ,"OrderString":""
        ,"SubSystemId":""
    }]
}

在这里插入图片描述

5. 测试物料查询API

以下是如何测试物料查询API的示例，获取关于物料（BD_Material）的信息：

5.1 Java代码示例

    /*本接口用于实现物料 (BD_Material)的单据查询功能*/
    @Test
    public void mtestQueryMaterial() throws Exception {
        var api = new K3CloudApi();
        String json = "{\n" +
                "    \"FormId\": \"BD_Material\",\n" +
                "    \"FieldKeys\": \"FMATERIALID,FNumber,FName,FCreateOrgId,FUseOrgId,\",\n" +
                "    \"FilterString\": \"\",\n" +
                "    \"OrderString\": \"\",\n" +
                "    \"TopRowCount\": 0,\n" +
                "    \"StartRow\": 0,\n" +
                "    \"Limit\": 2000,\n" +
                "    \"SubSystemId\": \"\"\n" +
                "}";
        String result = String.valueOf(api.executeBillQuery(json));
        System.out.println("物料单据查询接口: " + result);
    }