Python做Web API对接---单据查询接口

Cand

6人赞赏了该文章 8,872次浏览编辑于2019年04月23日 18:35:37

摘要由AI智能服务提供

本文介绍了Web API中的单据查询接口，主要用于查询指定时间段内未审核的单据并返回单据编号。文章以采购订单为例，详述了使用金蝶云Web API进行查询时所需的三个关键要素：URL链接、请求参数（包括FormId、FieldKeys、FilterString等）和Cookies用户验证。随后提供了Python代码示例，展示了如何通过登录函数获取Cookies，并调用查询接口获取数据。最后，文章提供了QQ群号以便用户交流问题。

有用

反馈

今天接着来分享一下Web API中的单据查询接口。这个接口，本质上就是在数据库上写SQL。如果你有过写SQL的经验，那么，它对于你来说，真的是小菜一碟。
好了，闲话不多说，进入正题：首先说一下我的需求：我想查询指定时间段内，未审核单据有哪些，并且给我返回单据编号。下面我以采购订单为例子进行讲解分析：同样地，我们需要准备好对接的三大利器：1：URL(链接)：单据查询接口的URL是：https://自己企业的登录域名 /K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.ExecuteBillQuery.common.kdsvc (固定不变）举个例子，如果贵公司的登录域名是：https://thisisatest.ik3cloud.com，那么，单据查询接口的URL就应该是：https://thisisatest.ik3cloud.com/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.ExecuteBillQuery.common.kdsvc顺便说明一下，我上面举例是用https协议的，而有的企业是http协议的，如果是的话，就要使用http协议。尽量复制域名，这样才不会出错，也别多复制一个k3cloud哈。2： Data(即请求参数)：打开金蝶的Web API功能，可以看到单据查询接口的请求参数有，如图所示：

这个接口的请求参数是非常少的。同时，你也要记住一个规则，金蝶云的Web API有个特点，非必填的参数是可以不用传的。所以，依据上面的原理，只有FormId，FieldKeys，FilterString才需要传上去。这几个参数解释一下：1：FormId，表单ID；

2：FieldKeys，需要返回的字段名，类似SQL语句中，select 后面的那堆字段名；3：FilterString，过滤条件，类似SQL语句中，where后面的条件，本质它就是拼接到where后面的；其他的参数在很多情况下，我都是不传的，除非有其对应的用处。因此，如果你想完成上面的需求的话，那么，你的请求参数应该是：post_data={"Data":{"FormId": "PUR_PurchaseOrder","FieldKeys": "FBillNo","FilterString": "FDocumentStatus='D' "}}千万别忘了，"Data"里面的value包数据必须是json格式的，这个需要用到json里面的dumps方法就完胜搞定，下面我会给例子。字段名的数据字典可通过如下方式获得，非常方便的。请看截图：

3：Cookies(用户验证,基于HTTP协议的)之前的文章已经说了如何通过API登录验证，这里就不多说了，需要看的话，点击链接查看即可：https://vip.kingdee.com/article/45012这里只是说一下，除了登录校验不需要cookies，其他的API接口都需要携带cookies进行操作的。建议写一个登录函数，然后返回 cookies，即可每次携带cookies访问了。可参照我下面的函数。如果没有携带，会出现如下的返回信息：

{"Result":{"ResponseStatus":{"ErrorCode":500,"IsSuccess":false,"Errors":[{"FieldName":null,"Message":"Context Is Null","DIndex":0}],"SuccessEntitys":[],"SuccessMessages":[],"MsgCode":1}}}我也看不懂，反正'IsSuccess'==False，我就知道是操作失败了。-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------好了，三大利器准备好了，我就直接上Python代码了：
import json,requests
login_url="https://pocknoiral.ik3cloud.com/k3cloud/Kingdee.BOS.WebApi.ServicesStub.AuthService.ValidateUser.common.kdsvc"
query_url="https://pocknoiral.ik3cloud.com/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.ExecuteBillQuery.common.kdsvc"
login_data={ "acctid":"20180321174312","username":"你的用户名","password":"你的密码","lcid":2052}
def login(): # 定义登录函数
login_response=requests.post(url=login_url,data=login_data)
return login_response.cookies # 返回cookies,方便下次访问时携带post_data={"data":json.dumps({"FormId": "PUR_PurchaseOrder","FieldKeys": "FBillNo","FilterString": "FDocumentStatus='D' "})}
response=requests.post(url=query_url,data=post_data,cookies=login())
print(response.text)

[["test"],["CGDD000003"]]拿到返回值，你就可以按照需求去处理下一个逻辑了。
非常感谢！！！
其他的分享，请关注评论内容，里面有链接。
-----------------------------------------------------------------------------------------------------------------------------------------------------------另外，如果大家有遇到问题，随时可以加我建立的QQ群：712623210 (金蝶云Web API系统集成沟通群) 。只要我能解决的，都会帮忙，毕竟大家都是一个行业的，相互交流，学习。-----------------------------------------------------------------------------------------------------------------------------------------------------------

赞 6 评论 5 收藏 11

Python做Web API对接---单据查询接口

恭喜您！