启动方案转API

发布版本：苍穹V3.0

上线日期：2021-01-29

补丁号：V3.0.004 (BIZ)

新特性介绍

• 启动方案转API

操作指引

1集成管理-集成API管理-集成API配置-启动方案转API

特性效果展示

启动方案API

 

1         概述

为提高集成平台的扩展性，集成云将部分接口封装为API供外部系统调用。启动方案API接口包括2中执行方式，从源系统查询数据同步到目标系统、将推送的源单数据同步到目标系统

。

2         API接口

基于苍穹平台的API接口（参考《金蝶云苍穹登录接口API开发指南》），开发自定义服务，API调用时序图如下：

图 开放API服务定义

一般地，启动方案通用API调用路径为：

http://localhost:8080/ierp/kapi/app/iscb/{apiNumber}

注意:调用时应将access_token加到请求的headers中。

 

2.1          从源系统查询数据同步到目标系统API

接口说明：

输入启动方案API编码apiNumber以及启动方案参数，返回任务ID（data）。

请求方式及url：

·    请求方式：POST

·     Content-type: application/json

·     access_token: 登录时获取的access_token

·      接口地址： /kapi/app/iscb/{apiNumber}

请求示例:

http://localhost:8080/ierp/kapi/app/iscb/{apiNumber}

请求参数说明：

url参数

apiNumber: 执行api编码

body参数（启动方案参数）

{
  “updatetime”: “2020-04-20 01:01:01”
 }

响应json：

{

    "success": true,

    "data": 885251493056549888,

    "errorCode": "success"

 }

2.2          将推送的源单数据同步到目标系统API

接口说明：

输入启动方案API编码apiNumber、启动方案对应集成方案的源单数据，返回任务ID（data）。

请求方式及url：

·    请求方式：POST

·     Content-type: application/json

.   access_token: 登录时获取的access_token

·     接口地址： /kapi/app/iscb/{apiNumber}

请求示例:

http://localhost:8080/ierp/kapi/app/iscb/{apiNumber}

请求参数说明：

url参数

apiNumber: 推送api编码

body参数（启动方案对应集成方案的源单数据）

{

    "data": {

        "createtime": 1588078994531,

        "entryentity": [

            {

                "seq": 0,

                "sex": true

            }

        ],

        "id": 0,

        "modifytime": 1588078994551,

        "name": "启动方案API",

        "number": "lcy_33"

    }

}

响应json：

{

    "success": true,

    "data": 885248716385359872,

    "errorCode": "success"

 }

2.3          执行结果查询API

接口说明：

输入执行命令command、任务ID executionId以及查询类型type，返回操作结果。

请求方式及url：

. 请求方式：POST

·     Content-type: application/json

.   access_token: 登录时获取的access_token

. 接口地址： /kapi/app/iscb/IscServiceDispatcher

请求示例:

http://localhost:8080/ierp/kapi/app/iscb/IscServiceDispatcher

请求参数说明：

url参数

command: "execution_result"

executionId: 任务ID

type: 查询类型 // GET_LOGS:查询任务执行日志，GET_STATE:查询任务执行状态

 

查询任务执行状态

body参数

{

    "command": "execution_result",

    "executionId": 879803065719631872,

    "type": "GET_STATE"

}

响应json：

{

    "success": true,

    "data": {

        "ignored_count": "0",

        "total_count": "0",

        "success_count": "0",

        "execution_number": "CF11ADC0-isc_demo_basedata_4-2",

        "failed_count": "0",

        "remark": null,

        "state": "S"

    },

    "errorCode": "success"

}

data属性字段	描述
ignored_count	忽略的行数
total_count	总行数
success_count	成功行数
execution_number	任务编码
failed_count	失败行数
remark	备注
state	执行状态：C-创建，R-执行中，S-完成，F-失败，X-撤销，W-等待，P-部分成功

 

 

 

查询任务执行日志

body参数

{

    "command": "execution_result",

    "executionId": 879803065719631872,

    "type": "GET_LOGS"

}

响应json：

{

    "success": true,

    "data": [

        {

            "target_data": "\"lcy_33\",\"name\":\"启动方案API\",\"createtime\":\"1588078994531\",\"modifytime\":\"1588078994551\",\"alias_name\":{\"zh_TW\":\"別名\",\"zh_CN\":\"别名\"},\"entryentity\":[{\"seq\