Python做Web API对接---下推接口
金蝶云社区-Cand
Cand
8人赞赏了该文章 6,565次浏览 未经作者许可,禁止转载编辑于2019年04月22日 22:19:09
summary-icon摘要由AI智能服务提供

本文介绍了Web API中的单据下推接口,以采购订单为例,说明了进行整单下推需要准备的三大要素:URL、Data(请求参数)、Cookies(用户验证)。详细说明了如何构建下推接口的URL、Data参数中必须传递的字段及如何通过Python代码进行下推操作,包括登录获取Cookies和执行下推请求。同时提供了处理常见问题和交流学习的途径。

今天接着来分享一下Web API中的单据下推接口。说明一下,本篇文章主要是介绍单据的整单下推的。
如需按指定明细下推,建议通过下游单据的保存接口去做会更快,我之前也分享了关于有源单的单据保存接口操作,你可以点击链接查看:
https://vip.kingdee.com/article/45025
如果你真的就只想通过下推接口按指定的明细去下推的话,可以加我QQ:784022507 (Cand),我在线教你。在这里我就不多说了。
下面我以采购订单为例子进行讲解分析:首先,同样地,我们需要准备好对接的三大利器:1:URL(链接):下推接口的URL是:https://企业的登录域名/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Push.common.kdsvc (固定不变)举个例子,如果贵公司的登录域名是:https://thisisatest.ik3cloud.com,那么,下推接口的URL就应该是:https://thisisatest.ik3cloud.com/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Push.common.kdsvc顺便说明一下,我上面举例是用https协议的,而有的企业是http协议的,如果是的话,就要使用http协议。尽量复制域名,这样才不会出错,也别多复制一个k3cloud哈。2: Data(即请求参数):打开金蝶的Web API功能,可以看到下推接口的请求参数有,如图所示:

第一次打开,一看,我cha !!! 心里一万个草泥马扑心而来,是不是。咋一个下推接口要这么多死鬼请求参数?别担心。我是分享心得的,肯定让你舒舒服服地把它给做了。
你要记住一个规则,金蝶云的Web API有个特点,非必填的参数是可以不用传的。
所以,按照以上原理,整单下推的话,Formid,Numbers,RuleId,3个都是必须传的,其他参数不需要传。1:Formid (表单ID)可以这样获取,如图:

2:Rule(单据转换规则唯一码)可以这样获取(假设采购订单下推至采购入库单),如图:


因此,如果你是想通过单据编号去整单下推生成采购入库单的话,你的请求参数应该是:post_data={"FormId":"PUR_PurchaseOrder","Data":{"RuleId":"PUR_PurchaseOrder-STK_InStock" , "Numbers": ["test"]}},Numbers对应的value是列表,它支持批量下推单据。千万别忘了,"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': None, '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"
push_url="https://pocknoiral.ik3cloud.com/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Push.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={"FormId":"PUR_PurchaseOrder","Data":json.dumps({"RuleId":"PUR_PurchaseOrder-STK_InStock" ,"Numbers": ["test"]})}
response=requests.post(url=push_url,data=post_data,cookies=login())
print(response.text)

返回信息:

{"Result":{"ResponseStatus":{"IsSuccess":true,"Errors":[],"SuccessEntitys":[{"Id":104868,"Number":"0208","DIndex":0}],"SuccessMessages":[],"MsgCode":0}}}返回信息中,"IsSuccess"==true,就说明下推成功了。

非常感谢!!!
其他的分享,请关注评论内容,里面有链接。
-----------------------------------------------------------------------------------------------------------------------------------------------------------另外,如果大家有遇到问题,随时可以加我建立的QQ群:712623210 (金蝶云Web API系统集成沟通群)。只要我能解决的,都会帮忙,毕竟大家都是一个行业的,相互交流,学习。-----------------------------------------------------------------------------------------------------------------------------------------------------------