开发文档

Site: GatewayApi

业务类API

接口说明

业务类API路由入口

请求地址url

http://[server_url]/Kisopenapi/router

注意:[server_url] 需通过 系统API(get_server_url) 动态获取

请求方式

Get/Post

认证方式

使用client_id、client_secret、access_token认证

调用限制

有每次请求数据流量限制

请求参数

调用API ,必须传入系统参数和应用参数(参数名称需区分大小写)。系统参数详细介绍如下;应用参数由于业务不同 API 各自不同,应用参数请参考具体的业务API 文档。

系统参数

参数名称参数类型是否必填参数说明
eidstring企业号 金蝶KIS账务平台V14.0如何获得企业号
netidstring网络ID ,如何获取netid?
client_idstring应用ID,即开发者申请的应用ID,如何获取client_id?
access_tokenstring开发者access_token,有效期10分钟(随timestamp过期而过期,值为md5( timestamp + client_id + client_secret + auth_token + state ),其中加号“+”为字符串连接符,client_id 、client_secret是开发者在开放平台后台申请(务必保密,切勿泄露,一旦泄露请及时更新),auth_token由企业管理员在系统管理内生成的访问口令,如何获取访问口令?
methodstringAPI接口名称(业务端接口名称,组成格式:kis.产品线简称.[功能模块|产品线简称].[控制器名称的前缀|接口方法名称]),形如:kis.APP004088.acctplatform.AcctController.DealAcctPlatForm,如何使用Method?
timestampstring时间戳,格式为yyyy-mm-dd HH:mm:ss,例如:2014-03-14 16:52:03,允许客户端请求时间误差为10分钟,需要urlencode,Get方式必须urlencode
verstringAPI协议版本,目前版本为 2.0,如:2.0
statestring请求端的状态值(由大于等于16位大小写字母和数字组成,要求每次的随机数不能重复,必须唯一)最多128字节,此值将作为返回值原样返回
fromtagstring来源标识
custdatastring应用参数数据包,应用API 业务json数据包,业务数据参数请参考API说明, 需urlencode处理

应用参数数据包custdata参数格式(业务参数注意大小写)

参数名称参数类型是否必填参数说明
ProductIDstring产品ID
AccountDBstring帐套 (根据具体业务需要是否必填,比如帐务平台此处帐套为必填项)
UserIDstring用户ID
PassWordstring密码
CurrentPagestring当前页
ItemsOfPagestring每页多少条记录
每页多少条记录string业务端Json数据包,业务数据参数请参考具体业务API说明(即Method参数对应的API名称)

返回结果

参数名称参数类型参数说明
Resultstring返回码:200 正常,大于200 异常
ErrMsgstring错误提示文本,如果Result大于200,会有相应的错误信息提,UTF-8编码,比如:
403 非法路由请求,access_token校验失败,client_secret或auth_token错误
303 超过数据流量
200 接口路由成功
201 接口路由失败,失败原因
若Result 小于 200,则为业务API的返回值
Statestring请求接口提交的state值,帮助开发者防范CSRF攻击
DataJsonstring业务端API的返回json数据

格式:

{

     “Result”:200,
     “ErrMsg”:”success”,
     “State”:”xxxxxx”,
     “DataJson”:{

            “Result”:”业务API返回代码”,
            “ErrMsg”:”业务API返回值说明”,
            “Data”:””,
              ……
             }

}

来源地址:https://open.kisdee.com/wiki/index.php?n=Site.GatewayApi
本页面最后修订于:2016年-06月-21日