1. Kingdee WEB API

1.1. 原理

• 金蝶WEBAPI原理

  基于RestFul架构的http+Json请求方式，cookie的接口登录授权、统一接口无需按单据区分接口（只需改变参数）

• EBS接口原理

  综合管理系统中，在相关单据的流程节点提交前编写 JavaScript 逻辑，调用系统预置的方法（runwebservic），请求后端Java服务，Java调用HTTP 请求，保存并返回给浏览器以模拟登录。登录成功后真正的业务接口把cookie 作为一个额外的参数传递给后端预定义的接口，实现接口调用。

1.2. 接口定义

1.2.1. 获取金蝶系统接口授权信息

1.2.2. EBS中定义登录接口

• URI

http://demo.com/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.AuthService.ValidateUser.common.kdsvc&&acctID=5e8f261b8f6559&username=demo&password=&lcid=2052

1.2.3. EBS中定义操作接口

同登录接口定义，根据具体接口调整URL和参数即可。

1.3. 附-详情接口

1.3.1. 1.1.1. 登陆验证接口

服务地址：

http://ServerIp/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.AuthService.ValidateUser.common.kdsvc

接口参数：

返回参数：

调用参考：

1）SDK辅助类示例（引用Kingdee.BOS.WebAPI.Client.dll）：

说明：下文中出现的client都为此处进行过登陆验证的ApiClient实例。

ApiClient client = new ApiClient("http://192.168.66.60/k3cloud/");
string dbId = "5756960b27b1aa"; //AotuTest117
bool bLogin = client.Login(dbId, "demo", "888888", 2052);
if (bLogin)
{
//todo:登陆成功处理业务 
}

2）无引用组件示例（不引用金蝶的组件）：

说明：以下HttpClient为自定义客户端调用辅助类，下文中所指HttpClient都表示这个类。

登陆验证参考：

  HttpClient httpClient = new HttpClient();

  httpClient.Url = "http://192.168.66.60/k3cloud/Kingdee.BOS.WebApi.ServicesStub.AuthService.ValidateUser.common.kdsvc";

  List<object> Parameters = new List<object>();

  Parameters.Add("558cbb01bfc79b");//帐套Id

  Parameters.Add("Administrator");//用户名

  Parameters.Add("888888");//密码

  Parameters.Add(2052);

  httpClient.Content = JsonConvert.SerializeObject(Parameters);

  var iResult = JObject.Parse(httpClient.AsyncRequest())["LoginResultType"].Value<int>();

  if (iResult == 1){

  //todo:验证成功，处理业务

  }

1.3.2. 1.1.2. 查看表单数据接口

服务地址：

http://ServerIp/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.View.common.kdsvc

接口参数：

返回参数：

调用参考：

1）SDK辅助类示例（引用Kingdee.BOS.WebAPI.Client.dll）：

 string sJson = "{\"Number\":\"SVINV00000003\"}"; 

  var result = client.Execute<string>("Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.View",

  new object[] { "IV_SALESIC", sJson })

2）无引用组件示例（不引用金蝶的组件）：

HttpClient httpClient = new HttpClient();

httpClient.Url = "http://192.168.66.60/k3cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.View.common.kdsvc";

List<object> Parameters = new List<object>();

//业务对象Id 

String formid = "IV_SALESIC";//发票

Parameters.Add(formid);

//Json字串

string data = "{\"Number\":\"SVINV00000003\"}";

Parameters.Add(data);

httpClient.Content = JsonConvert.SerializeObject(Parameters);

var result = httpClient.AsyncRequest();

1.3.3. 1.1.3. 保存表单数据接口

服务地址：

http://ServerIp/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Save.common.kdsvc

接口参数：

返回参数：

1.3.4. 1.1.4. 批量保存表单数据接口

服务地址：

http://ServerIp/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.BatchSave.common.kdsvc

接口参数：

返回参数：

1.3.5. 1.1.5. 提交表单数据接口

服务地址：

http://ServerIp/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Submit.common.kdsvc

接口参数：

返回参数：

1.3.6. 1.1.6. 审核表单数据接口

服务地址：

http://ServerIp/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Audit.common.kdsvc

接口参数：

返回参数：

1.3.7. 1.1.7. 反审核表单数据接口

服务地址：

http://ServerIp/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.UnAudit.common.kdsvc

接口参数：

返回参数：

1.3.8. 1.1.8. 删除表单数据接口

服务地址：

http://ServerIp/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Delete.common.kdsvc

接口参数：

返回参数：

1.3.9. 1.1.9. 表单数据查询接口

服务地址：

http://ServerIp/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.ExecuteBillQuery.common.kdsvc

接口参数：

1.3.10. 1.1.10. 自定义WebAPI接口

服务地址：

http://ServerIp/K3Cloud/接口命名空间.接口实现类名.方法,组件名.common.kdsvc

例如：

"http://192.168.66.60/k3cloud/ApiServiceTest.AAA.CustomBusinessService.ExecuteService,ApiServiceTest.AAA.common.kdsvc"

需要注意的是，自定义webapi接口服务地址中比其他标准接口地址多了一个组件名，如果需要和其他其他标准接口保持一致，则二开自定义的webapi接口命名空间必须以.ServicesStub结尾，例如以下示例自定义接口则其服务地址可以参考如下格式：

"http://192.168.66.60/k3cloud/Kingdee.K3Erp.WebAPI.ServiceExtend.ServicesStub.CustomBusinessService ExecuteService.common.kdsvc"

​

1.3.11. 1.1.11. 登录验证接口带踢人功能

服务地址：

http://ServerIp/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.AuthService.ValidateUser2.common.kdsvc

接口参数：

1.3.12. 1.1.12. 暂存表单数据接口

服务地址：

http://ServerIp/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Draft.common.kdsvc

接口说明：

请参考保存接口。

1.3.13. 1.1.13. 分配表单数据接口

服务地址：

http://ServerIp/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Allocate.common.kdsvc

接口参数：

返回参数：

1.3.14. 1.1.14 下推接口

服务地址：

http://ServerIp/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Push.common.kdsvc

接口参数：

返回参数：

1.3.15. 1.1.15 分组保存接口

服务地址：

http://ServerIp/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.GroupSave.common.kdsvc

接口参数：

返回参数：

1.3.16. 1.1.16 弹性域保存接口

服务地址：

http://ServerIp/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.FlexSave.common.kdsvc

接口参数：

返回参数：

1.3.17. 1.1.17 发送消息接口

服务地址：

http://ServerIp/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.SendMsg.common.kdsvc

接口参数：

1.3.18. 1.1.18 登出接口

服务地址：

http://ServerIp/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.AuthService.Logout.common.kdsvc

接口参数：

返回结果：true/false 成功or失败

1.3.19. 1.1.19 空操作接口

服务地址：

http://ServerIp/K3Cloud/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.ExecuteOperation.common.kdsvc

接口参数：

返回参数：

1.4. EBS代码示例

以流程节点通过JavaScript提交为例（但不限于节点）

var strcookie = "";
operation = "abort";
var object={
            "NeedUpDateFields": [],
            "NeedReturnFields": [],
            "IsDeleteEntry": "true",
            "SubSystemId": "",
            "IsVerifyBaseDataField": "false",
            "IsEntryBatchFill": "true",
            "ValidateFlag": "true",
            "NumberSearch": "true",
            "InterationFlags": ""
}
var model = {
    "FID": 0,
    "FCreateOrgId": {
        "FNumber": order.ord_jdzz
    },
    "FUseOrgId": {
        "FNumber": order.ord_jdzz
    }
    //"FName": data.getElementsByTagName("ord_wlswmc")[0].innerHTML,
}
var ids = "";
proj_getdw.runsql4xml(function(iseof, data, dsname) {
    if (!iseof && dsname == "t1") {
        //console.log(data);
        if(data.getElementsByTagName("ord_spwxsw")[0].innerHTML == '是') {
           model["FName"] = data.getElementsByTagName("ord_wlswmc")[0].innerHTML,
           object["Model"] = model;

           //保存
            runwebservice("qsy_voucher_login_ml",{},function(result,data){    
                eval("kingdee_login_result="+data)
                console.log("kingdee_login_result.KDSVCSessionId="+kingdee_login_result.KDSVCSessionId+"____;document.cookie="+document.cookie);

                if(kingdee_login_result.LoginResultType==-5||kingdee_login_result.LoginResultType==1){    
                    strcookie = document.cookie;
                    runwebservice("qsy_voucher",{cookie: tohex2(strcookie),postdata:JSON.stringify({formid:"FIN_OTHERS",data:JSON.stringify(object)})},function(result,data){
                        eval("kingdee_result="+data);
                        if(kingdee_result.Result.ResponseStatus.IsSuccess === true){
                            ids = kingdee_result.Result.Id;
                            var object1 = {
                                "CreateOrgId": 0,
                                "Numbers": [],
                                "Ids": kingdee_result.Result.Id,
                                "SelectedPostId": 0,
                                "NetworkCtrl": ""
                            };                
                            //提交
                        runwebservice("qsy_vouch_submit",{cookeie: tohex2(strcookie),postdata:JSON.stringify({formid:"FIN_OTHERS",data:JSON.stringify(object1)})},function(result,data){
                            eval("kingdee_result1="+data);                   
                            if(kingdee_result1.Result.ResponseStatus.IsSuccess === true){
                                var object2 = {
                                    "CreateOrgId": 0,
                                    "Numbers": [],
                                    "Ids": kingdee_result1.Result.Id,
                                    "InterationFlags": "",
                                    "NetworkCtrl": ""
                                    }                        
                                    //审核
                                runwebservice("qsy_vouch_audit",{cookeie: tohex2(strcookie),postdata:JSON.stringify({formid:"FIN_OTHERS",data:JSON.stringify(object2)})},function(result,data){
                                    eval("kingdee_result2="+data);
                                    console.log(data);
                                    if(kingdee_result2.Result.ResponseStatus.IsSuccess === true){
                                        operation = "continue";
                                            //alert("接口提交完成");
                                            applyjob_();/*继续提交流程*/
                                    }
                                    else{
                                        alert("其它往来单位审核接口异常提示"+data);
                                    }
                                })
                            }
                            else{
                                alert("其它往来单位提交接口异常提示"+data);
                            }
                        });
                            //operation = "continue";
                            //alert("接口提交完成");
                            //applyjob_();/*继续提交流程*/
                        }else{
                        alert("接口异常提示"+data);
                        }
                })    
                }
            })

        }
    }
});

1.5. 附-官方文档

https://vip.kingdee.com/article/9185