集成方案API
集成方案API使用方法
作者：吴宏超
1. 概述
为提高集成平台的扩展性，集成云将部分接口封装为API供外部系统调用。集成方案API基本接口包括查询、转换、推送执行四类，业务可以根据自身需求选取。
2. API接口
基于苍穹平台的API接口（参考《金蝶云苍穹登录接口API开发指南》），开发自定义服务，API调用时序图如下：
当在”集成方案转API”界面中将该API启用后，该API将会被注册到”开放平台”，至此方可使用该API。
一般地，集成方案通用API调用路径示例为：
http://{ip}:{port}/{webapp}/kapi/app/iscb/{api_number}（注意：要先设置header参数，详见第2节示例），也可以参考测试界面生成的URL，如下图所示：
2.1 取数API（PULL）
2.1.1 接口说明
从来源系统取数并转换为目标单数据。
输入：集成方案的参数值，
输出：转换后的目标单数据
注意：应在方案中设置合适的过滤条件，避免一次性返回太多数据行，最多取1000行。
接口地址：/kapi/app/iscb/{api_number}
请求方式：POST
Header参数:
Content-type: application/json
access_token: 登录苍穹拿到的access_token，根据实际情况填写
请求body参数：
如果集成方案有则按实际填写，否则传递一个空map。
2.1.2 请求示例
现有api编码为user_list-isc_demo_basedata_1_PULL，本地苍穹全名地址为：http://172.19.110.215:8080/ierp， 则其调用URL如下：
http://172.19.110.215:8080/ierp/kapi/app/iscb/user_list-isc_demo_basedata_1_PULL
_user_list-isc_demo_basedata_1_PULL: 登记的集成方案api编码，根据实际情况填写
请求头（header）：
access_token: nGVHOcmxW7z9QwSp4Ai1OGHfIbFeIX4x2eDXX1xz6LOJs6dOmA9AMsE4zLI4u2C987VUxV3HtJ3V3JKsbFL41he2WmDbm7TKPLO3rrKapeFLDvg6yXoq8ADMjyrFv1vn // 根据实际情况填写
Content-type: application/json
请求体（body）：
{"page":1, // 该API的输入参数，根据实际情况填写
"pageSize":1 // 该API的输入参数，根据实际情况填写
}
输出结果:
{"data":[
{"number":"admin",
"name":"管理员",
"creator":"1",
"createtime":"2021-02-04 08:38:15",
"modifier":"1",
"modifytime":"2021-02-04 08:38:15",
"alias_name":{"zh_TW":"admin",
"zh_CN":"admin"
}
}
],
"errorCode":"success",
"success":true
}
2.2 转换API（TRANSFER）
2.2.1 接口说明
将源单数据转换为目标单数据。
输入：源单数据
输出：转换后的目标单数据
接口地址：/kapi/app/iscb/{api_number}
2.2.2 请求示例
现有api编码为dc__user_list-isc_demo_basedata_1_TRANSFER，本地苍穹全名地址为：http://172.19.110.215:8080/ierp， 则其调用URL如下：
http://172.19.110.215:8080/ierp/kapi/app/iscb/dc__user_list-isc_demo_basedata_1_TRANSFER
请求头（header）：
与2.1.2小节相同
请求体（body）：
{ "data":{"realname":"df", // 输入参数，根据API文档填写
"username":"df" // 输入参数，根据API文档填写
}
}
结果:
{"data":[
{"number":"df",
"name":"df",
"creator":"1",
"createtime":"2021-02-04 08:51:50",
"modifier":"1",
"modifytime":"2021-02-04 08:51:50",
"alias_name":{"zh_TW":"df",
"zh_CN":"df"
}
}
],
"errorCode":"success",
"success":true
}
2.3 推送API（PUSH）
2.3.1 接口说明
将源单数据转换后推送到目标系统。
输入：输入源单数据data（可以为列表），
输出：各数据的执行结果id, type, errorMessage，如果一条数据异常，接口将终止。
接口地址：/kapi/app/iscb/{api_number}
2.3.2 请求示例
现有api编码为dc__user_list-isc_demo_basedata_1_PUSH，本地苍穹全名地址为：http://172.19.110.215:8080/ierp， 则其调用URL如下：
http://172.19.110.215:8080/ierp/kapi/app/iscb/dc__user_list-isc_demo_basedata_1_PUSH
请求头（header）：
与2.1.2小节相同
请求体（body）：
{ "data":{"realname":"sa",// 输入参数，根据API文档填写
"username":"sa"// 输入参数，根据API文档填写
}
}
结果:
{"data":[
{"tarId":"1083811993191758848",
"errorMessage":null,
"id":"1083811993191758848",
"type":"INSERT"
}
],
"errorCode":"success",
"success":true
}
此时查看集成方案是否已经执行完毕，或看数据是否写入目标系统。
2.4 执行API（EXECUTE）
2.4.1 接口说明
从来源系统取数推送到目标系统。
输入：源单过滤条件
输出：各数据的执行结果id, type, errorMessage，如果一条数据异常，接口将终止。
接口地址：/kapi/app/iscb/{api_number}
2.4.2 请求示例
现有api编码为dc__user_list-isc_demo_basedata_1_EXECUTE，本地苍穹全名地址为：http://172.19.110.215:8080/ierp， 则其调用URL如下：
http://172.19.110.215:8080/ierp/kapi/app/iscb/dc__user_list-isc_demo_basedata_1_EXECUTE
请求头（header）：
与2.1.2小节相同
请求体（body）：
{"page":1, // 输入参数，根据API文档填写
"pageSize":1// 输入参数，根据API文档填写
}
结果:
{"data":[
{"tarId":"1083813749212630016",
"srcId":null,
"errorMessage":null,
"id":"1083813749212630016",
"type":"INSERT"
}
],
"errorCode":"success",
"success":true
}
此时查看集成方案是否已经执行完毕，或看数据是否写入目标系统。
集成服务云使用指南：https://club.kdcloud.com/article/45312
集成服务云新特性发布汇总：https://club.kdcloud.com/article/146134
集成方案API
本文2024-09-23 00:52:37发表“云苍穹知识”栏目。
本文链接：https://wenku.my7c.com/article/kingdee-cangqiong-142310.html
