Python做Web API对接---基础资料保存接口
金蝶云社区-Cand
Cand
17人赞赏了该文章 1万次浏览 未经作者许可,禁止转载编辑于2019年04月19日 21:23:59
summary-icon摘要由AI智能服务提供

本文介绍了Web API中的基础资料保存接口,以物料为例详细说明了接口的使用方法。包括URL链接的构成、请求参数的构建(尤其是model内参数的传递)、及cookies的必要性。文章还提供了Python代码示例,展示了登录验证及物料保存接口的调用过程,并强调了非必填参数的处理技巧及自动提交审核参数的使用。最后,作者鼓励读者关注评论中的链接,并提供了QQ群号以便交流。

今天接着来分享一下Web API中的save接口。保存接口:分为单据保存接口,和基础资料保存接口;本篇文章主要是介绍基础资料保存接口,后续会分享关于单据的保存接口。请关注评论内容,里面有链接。下面以物料为例,其他基础资料的API保存原理也是一样(如客户,供应商等等)保存接口的内容有点多,你一定要细心看下去,对其他的API操作也是有帮助的。
同样地,准备好对接的三大利器:
1:URL(链接):
保存接口的URL是:https://己企业的登录域名 + /k3Cloud/Kingee.Bos.WebApi.ServicesStub.DynamicFormservice.Save.Common.KDSVC (固定不变)举个例子,如果贵公司的登录域名是:https://thisisatest.ik3cloud.com,那么,保存接口的URL就应应该是:https://thisisatest.ik3cloud.com/k3Cloud/Kingee.Bos.WebApi.ServicesStub.DynamicFormservice.Save.Common.KDSVC 顺便说明一下,我上面举例是用https协议的,而有的企业是http协议的,如果是的话,就要使用http协议。尽量复制域名,这样才不会出错,也别多复制一个k3cloud哈。
2: Data(即请求参数):
打开金蝶的Web API功能,可以看到保存接口的请求参数有,如图所示


第一次打开,一看,我cha !!! 心里一万个草泥马扑心而来,是不是。咋一个保存接口要这么多死鬼请求参数?不仅仅如此哦。我跟你说一下我当时的分析思路哦:外部有两个参数,1,formid,2,data。然后data里面又包含了12个参数,接着到第12个参数Model里面,又包含了一大堆参数。分析到这里,我就彻底懵逼,对吧。别担心。我是分享心得的,肯定让你舒舒服服地把它给做了。
首先,你要记住一个规则,金蝶云的Web API有个特点,非必填的参数是可以不用传的。
看到这里,有的朋友就问,非必填的话,我可以传空值吗?答案是:有时候可以,但有的时候就不可以,因为空值有的时候会报错(未将对象引用设置到对象的实例),这个就是典型的:没有实例化。传了key,然后服务器找不到value。如果不传key,那么就不会报这个错。所以非必填的参数能不传就不传。千万要记住这一点。记住这一点后,你的成功率就达到90%以上了!!!然后估计又有人问了,那我哪知道哪些是必传,哪些是非必传呢?看下面截图:

看到没有??formid是必传的,data也是必传的,然后data里面的Model也是必传的。你心里肯定在想,这不是废话吗???别急,关键的来了。让人最激动的地方来了:看截图

开心不,激动不,Happy不,data里面的一大串参数不需要传!不需要传!不需要传!重要的事情所三遍!!!所以,先总结一下,请求参数就应该是post_data={ "formid" : "BD_MATERIAL" , "data" : {"model":{}},(这里需说明一下,model里面数据就是单据的主数据,包括单据头数据,单据体数据)
接着你肯定会想到,那Model里面也有很多参数,我是不是同样的道理,只要传我想要的就行了??非常正确!!!Web API就是如此简单。所以,你就会想,我手工新增物料的时候,如果没有特殊要求,我点击新增,只需要把物料的名称写上去,就可以保存提交审核了。那么,API保存也是如此吗?是的!Model里面可以只包含你想要的参数就行。因此按照上面的需求,请求参数就应该是post_data={ "formid" : "BD_MATERIAL" , "data" : {"Model":{ "FName": ""}},此处需注意一下,"data"的value数据必须是json格式的,这个需要用到json里面的dumps方法就完胜搞定,下面我会给例子。你心里肯定又有疑问了,如果我不传的话,那它保存之后是什么值?记住:答案是:缺省值(默认值)。不传的那些字段,它是会自动默认缺省值的。不信你可以测试不传,然后保存成功后查看一下。顺便说一下,如果有一些字段不是系统出厂就有的,而是你在BOS上二开自定义增加的,那你就把这个字段名给加到Model里面,然后给它你想要传的value值,例如,你在物料上加了一个字段叫FPython文本框,那你的请求参数就应该是post_data={ "formid" : "BD_MATERIAL" , "data" : {"Model" : { "FName": "","FPython":" "}}记住,一定是加到Model里面的。Model才是真正的要上传数据。
字段名可以在BOS上面找到,也可以在选择保存接口后往下面拉,如图。它也是有数据字段的。


讲了这么多,大家应该知道怎么去构建请求参数了吧。是不是清晰了很多。再跟大家说一个技巧,先截图:

IsAutoSubmitAndAudit:是否自动提交与审核,布尔类型,默认false(非必录) 注(启用此参数,保存,提交和审核是在一个事务中)看到这个参数了吗?顾名思义,它是可以帮你在保存物料的同时,还可以自动提交审核,够爽吧。当为true时,会自动帮你提交审核的,你连提交审核的接口都不需要再调用了。记得哦。很大效率的一个参数。
3Cookies(用户验证,基于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 requests,jsonlogin_url="https://pocknoiral.ik3cloud.com/k3cloud/Kingdee.BOS.WebApi.ServicesStub.AuthService.ValidateUser.common.kdsvc"
save_url ="https://pocknoiral.ik3cloud.com/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Save.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 = {"Model": {"FName": "apitest"}}
data = {"FormID": "BD_MATERIAL", "Data": json.dumps(post_data)}
save_response = requests.post(url=save_url,data=data,cookies=login())
print(save_response.text)
这里顺便夸一下Python,个人感觉,它代码真的是超级简洁的,哈哈哈哈哈哈哈哈,
下面看提交结果:

返回信息中:IsSuccess == true,说明物料保存成功了!

看到上面的结果图没有,我的Model里面只传了FName,其他的字段都没有传值,而它自动会帮你设为默认值。这样就大大地减少工作量以及出错率了。
截止至此,希望你能很透彻地理解金蝶云的Web API了。

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