业务类API路由入口
http://[server_url]/Kisopenapi/router
注意:[server_url] 需通过 系统API(get_server_url) 动态获取
Get/Post
使用client_id、client_secret、access_token认证
有每次请求数据流量限制
调用API ,必须传入系统参数和应用参数(参数名称需区分大小写)。系统参数详细介绍如下;应用参数由于业务不同 API 各自不同,应用参数请参考具体的业务API 文档。
参数名称 | 参数类型 | 是否必填 | 参数说明 |
---|---|---|---|
eid | string | 是 | 企业号 金蝶KIS账务平台V14.0如何获得企业号 |
netid | string | 是 | 网络ID ,如何获取netid? |
client_id | string | 是 | 应用ID,即开发者申请的应用ID,如何获取client_id? |
access_token | string | 是 | 开发者access_token,有效期10分钟(随timestamp过期而过期,值为md5( timestamp + client_id + client_secret + auth_token + state ),其中加号“+”为字符串连接符,client_id 、client_secret是开发者在开放平台后台申请(务必保密,切勿泄露,一旦泄露请及时更新),auth_token由企业管理员在系统管理内生成的访问口令,如何获取访问口令? |
method | string | 是 | API接口名称(业务端接口名称,组成格式:kis.产品线简称.[功能模块|产品线简称].[控制器名称的前缀|接口方法名称]),形如:kis.APP004088.acctplatform.AcctController.DealAcctPlatForm,如何使用Method? |
timestamp | string | 是 | 时间戳,格式为yyyy-mm-dd HH:mm:ss,例如:2014-03-14 16:52:03,允许客户端请求时间误差为10分钟,需要urlencode,Get方式必须urlencode |
ver | string | 是 | API协议版本,目前版本为 2.0,如:2.0 |
state | string | 是 | 请求端的状态值(由大于等于16位大小写字母和数字组成,要求每次的随机数不能重复,必须唯一)最多128字节,此值将作为返回值原样返回 |
fromtag | string | 否 | 来源标识 |
custdata | string | 是 | 应用参数数据包,应用API 业务json数据包,业务数据参数请参考API说明, 需urlencode处理 |
参数名称 | 参数类型 | 是否必填 | 参数说明 |
---|---|---|---|
ProductID | string | 否 | 产品ID |
AccountDB | string | 否 | 帐套 (根据具体业务需要是否必填,比如帐务平台此处帐套为必填项) |
UserID | string | 否 | 用户ID |
PassWord | string | 否 | 密码 |
CurrentPage | string | 否 | 当前页 |
ItemsOfPage | string | 否 | 每页多少条记录 |
每页多少条记录 | string | 是 | 业务端Json数据包,业务数据参数请参考具体业务API说明(即Method参数对应的API名称) |
参数名称 | 参数类型 | 参数说明 |
---|---|---|
Result | string | 返回码:200 正常,大于200 异常 |
ErrMsg | string | 错误提示文本,如果Result大于200,会有相应的错误信息提,UTF-8编码,比如: 403 非法路由请求,access_token校验失败,client_secret或auth_token错误 303 超过数据流量 200 接口路由成功 201 接口路由失败,失败原因 若Result 小于 200,则为业务API的返回值 |
State | string | 请求接口提交的state值,帮助开发者防范CSRF攻击 |
DataJson | string | 业务端API的返回json数据 |
{
“Result”:200, “ErrMsg”:”success”, “State”:”xxxxxx”, “DataJson”:{ “Result”:”业务API返回代码”, “ErrMsg”:”业务API返回值说明”, “Data”:””, …… }
}