【C#开发教程】使用web API 查询即时库存信息案例

本文将展示如何使用 K3Cloud API 来查询即时库存内容，帮助企业实现更高效的库存监管。

1. 连接 K3Cloud API

首先，我们需要连接到 K3Cloud 的 API。为此，我们使用 K3CloudApiClient 类创建一个客户端实例，并指定 API 的 URL。这个连接是后续所有操作的基础。

# 创建 API 客户端  client = K3CloudApiClient("https://ip地址/K3Cloud/")

2. 验证用户登录

在访问 API 之前，我们需要进行身份验证。使用 ValidateLogin 方法，传入用户的唯一标识、用户名、密码以及组织ID进行登录。登录结果以 JSON 格式返回。

# 登录系统并获取登录结果  loginResult = client.ValidateLogin("1361434108470788096", "张三", "123456", 2052)

3. 解析登录结果

成功登录后，我们需要解析返回结果以检查登录是否成功。LoginResultType 值为 1 表示登录成功，否则，需处理相应的错误。

# 解析登录结果类型  resultType = JObject.Parse(loginResult)["LoginResultType"]

4. 准备查询参数

如果登录成功，我们接下来需准备查询库存的参数。我们的目标是获取即时库存信息，因此需要设定请求的表单ID、要检索的字段、过滤条件、排序方式以及数量限制等。

# 准备查询参数  para = {  
    "FormId": "STK_Inventory",  
    "FieldKeys": "FStockOrgId,FStockId,FQty",  # 获取库存组织ID、库存ID和数量  
    "FilterString": [],  
    "OrderString": "",  
    "TopRowCount": 0,  
    "StartRow": 0,  
    "Limit": 2000,  
    "SubSystemId": ""  }  
jsonString = JsonConvert.SerializeObject(para)  # 将参数转换为 JSON 字符串

5. 执行库存查询

在准备好查询参数后，我们可以调用 ExecuteBillQuery 方法执行库存查询。该方法会将请求发送到 K3Cloud API，并返回获取的库存数据。

if resultType == 1:  
    # 登录成功，执行库存查询  
    json = client.ExecuteBillQuery(jsonString)

6. 解析和处理查询结果

API 返回的数据一般是一个 JSON 数组，其中每个元素代表一条库存记录。我们可以遍历这些记录，提取感兴趣的信息，比如库存组织ID、库存ID和库存数量。

    # 解析返回的数据  
    for record in json:  
        stockOrgId = record["FStockOrgId"]  # 获取库存组织ID  
        stockId = record["FStockId"]  # 获取库存ID  
        quantity = record["FQty"]  # 获取库存数量  
        
        # 打印或处理库存记录  
        print(f"库存组织ID: {stockOrgId}, 库存ID: {stockId}, 数量: {quantity}")  
else:  
    # 登录失败，抛出异常或打印错误信息  
    raise Exception("登录失败，错误代码：" + str(resultType))

总结

通过上述步骤，我们成功地使用 K3Cloud API 查询了即时库存信息。这套流程为企业提供了一个有效的方式来访问和管理库存数据。通过自动化查询，企业可以实时掌握库存状态，从而提升运营效率，改善供应链管理。

在实际应用中，我们还可以根据具体需求，对查询参数进行更细致的调整，获取更为精准的数据。这不仅提高了工作效率，也为决策提供了重要依据。如果有进一步的需求，可以考虑根据业务变化对系统进行二次开发与优化。

完整代码，点击查看更多金蝶开发教程

# 创建 API 客户端  
client = K3CloudApiClient("https://IP地址/K3Cloud/")  
# 登录系统并获取登录结果  
loginResult = client.ValidateLogin("1361434108470788096", "张三", "123456", 2052)  

# 解析登录结果类型  
resultType = JObject.Parse(loginResult)["LoginResultType"]  

# 准备查询参数  
para = {  
    "FormId": "STK_Inventory",  
    "FieldKeys": "FStockOrgId,FStockId,FQty",  # 除了库存组织ID，还可以获取库存ID和数量  
    "FilterString": [],  
    "OrderString": "",  
    "TopRowCount": 0,  
    "StartRow": 0,  
    "Limit": 2000,  
    "SubSystemId": ""  
}  
jsonString = JsonConvert.SerializeObject(para)  # 将参数转换为 JSON 字符串  

# 判断登录是否成功  
if resultType == 1:  
    # 登录成功，执行库存查询  
    json = client.ExecuteBillQuery(jsonString)  
    
    # 解析返回的数据  
    for record in json:  
        # 在这里处理每个库存记录  
        stockOrgId = record["FStockOrgId"]  # 获取库存组织ID  
        stockId = record["FStockId"]  # 获取库存ID  
        quantity = record["FQty"]  # 获取库存数量  
        
        # 打印或处理库存记录  
        print(f"库存组织ID: {stockOrgId}, 库存ID: {stockId}, 数量: {quantity}")  
else:  
    # 如果登录失败，抛出异常或打印错误信息  
    raise Exception("登录失败，错误代码：" + str(resultType))