异步接口对接指南

接口鉴权

仅通过HTTP方是需要鉴权
见文档：https://apifox.com/apidoc/shared-b7075533-cffe-403f-9c67-ecda25d00270

服务地址

HTTP服务地址

环境	请求地址
SIT测试	http://fms2-sit.linshimuye.com/k3proxy/
UAT测试	http://fms2-uat.linshimuye.com/k3proxy/
正式	http://fms2.linshimuye.com/k3proxy/

RocketMq服务地址与TOPIC

请求

环境	地址	请求TOPIC	请求TAG
开发	暂无	暂无	k3proxy
SIT测试	http://10.10.14.248:9876	FIN_K3PROXY_REQUEST_SIT	k3proxy
UAT测试	http://10.10.14.248:9876	FIN_K3PROXY_REQUEST_UAT	k3proxy
正式	http://MQ_INST_1461650476285662_BailIHu4.mq-internet-access.mq-internet.aliyuncs.com:80	FIN_K3PROXY_REQUEST_PROD	k3proxy

响应

环境	地址	响应TOPIC（推荐）	响应TAG
开发	暂无	暂无	请求发起方在请求参数中指定
SIT测试	http://10.10.14.248:9876	推荐使用FIN_ASYNC_RESULT_SIT，也可请求发起方在请求参数resultTopic指定	请求发起方在请求参数resultTag指定
UAT测试	http://10.10.14.248:9876	推荐使用FIN_ASYNC_RESULT_SIT，也可请求发起方在请求参数resultTopic指定	请求发起方在请求参数resultTag指定
正式	http://MQ_INST_1461650476285662_BailIHu4.mq-internet-access.mq-internet.aliyuncs.com:80	推荐使用FIN_ASYNC_RESULT_SIT，也可请求发起方在请求参数resultTopic指定	请求发起方在请求参数resultTag指定

异步请求发起

异步请求的发起有两种方式
方式一：通过http接口进行调用
SIT环境请求地址：http://fms2-sit.linshimuye.com/k3proxy/open/v1/asyncInvoke

方式二：通过RocketMq生产者
其他系统直接往RocketMq的请求TOPIC中写入消息

异步请求结果获取

异步请求的结果获取有两种方式
方式一：通过http接口轮询
SIT环境请求地址：http://fms2-sit.linshimuye.com/k3proxy/open/v1/asyncResult

方式二：通过RocketMq订阅
其他系统直接订阅RocketMq的结果TOPIC，结果的TPIC在请求参数中传入

请求参数

参数	参数名	类型	是否必填	描述
requestId	请求id	String	是	请求唯一id，各系统使用前缀+唯一值的方式进行凭借，例：SCM151DFK75、ODS45dfd52g4
resultTopic	结果回调topic	String	否	异步请求结果将放入改topic中，业务方可订阅该topic获取请求结果。如果不传时，结果将不会放入topic，只能通过http轮询获取结果
resultTag	结果回调tag	String	否	结果回调时，会指定mq消息的tag，用于业务方进行订阅
content	请求内容	String	是	具体的业务请求参数

请求示例

以ODS，发起创建直接调拨单为例
TOPIC: FIN_K3PROXY_REQUEST_SIT
TAG: k3proxy

{
    "requestId": "4PL00001",
    "resultTag": "createTransferDirect",
    "content": {
        "operateType": "Save",
        "appKey": "4PL",
        "formId": "STK_TransferDirect",
        "data": "{\"NeedReturnFields\":[],\"IsVerifyBaseDataField\":\"true\",\"Model\":{\"FBillTypeID\":{\"FNUMBER\":\"ZJDB01_SYS\"},\"FStockOutOrgId\":{\"FNumber\":\"101\"},\"FOwnerTypeOutIdHead\":\"BD_OwnerOrg\",\"FOwnerOutIdHead\":{\"FNumber\":\"101\"},\"FStockOrgId\":{\"FNumber\":\"101\"},\"FOwnerTypeIdHead\":\"BD_OwnerOrg\",\"FOwnerIdHead\":{\"FNumber\":\"101\"},\"FDate\":\"2023-11-11 00:00:00\",\"F_LS_HOutBillNo\":\"ODS001\",\"F_LS_HOutBillType\":\"原单类型\",\"F_LS_HOutSysId\":\"ODS\",\"FBillEntry\":[{\"FMaterialId\":{\"FNumber\":\"LS01RCR300014\"},\"FUnitID\":{\"FNumber\":\"piece\"},\"FQty\":1.0,\"FLot\":{\"FNumber\":\"BLSC20220331-2331\"},\"FSrcStockId\":{\"FNumber\":\"CP\"},\"FDestStockId\":{\"FNumber\":\"CPDF\"},\"FBomId\":{\"FNumber\":\"LS01RCR300014_V1.0\"},\"F_LS_OutBillTypeE\":\"原单类型\",\"F_LS_OutBillNoE\":\"ODS001\",\"F_LS_OutBillEntryId\":\"11111\"},{\"FMaterialId\":{\"FNumber\":\"LS01RCR300014\"},\"FUnitID\":{\"FNumber\":\"piece\"},\"FQty\":2.0,\"FLot\":{\"FNumber\":\"BLSC20220331-2331\"},\"FSrcStockId\":{\"FNumber\":\"CP\"},\"FDestStockId\":{\"FNumber\":\"CPDF\"},\"FBomId\":{\"FNumber\":\"LS01RCR300014_V1.0\"},\"F_LS_OutBillTypeE\":\"原单类型\",\"F_LS_OutBillNoE\":\"ODS001\",\"F_LS_OutBillEntryId\":\"22222\"}]}}"
    },
    "resultTopic": "4PL_FIN_ASYNCRESULT_SIT"
}

响应参数

参数	参数名	类型	是否必填	描述
isSuccess	是否成功	bool	是
errorCode	错误编码	long	是
message	响应msag	String	是
data	响应数据体	AsyncResult	是	异步请求响应体
AsyncResult格式如下
requestId	异步请求id	String	是	同发起请求的requestId
status	异步请求状态	int	是	1-处理中 2-成功 3-失败
msg	异步请求响应msag	String	是
resultTopic	结果回调topic	String	否	异步请求结果将放入改topic中，业务方可订阅该topic获取请求结果。如果不传时，结果将不会放入topic，只能通过http轮询获取结果
resultTag	结果回调tag	String	否	结果回调时，会指定mq消息的tag，用于业务方进行订阅
data	异步请求响应结果	Object	是	具体的业务请求结果

响应示例

以ODS，发起创建直接调拨单为例
TOPIC: FIN_ASYNC_RESULT_SIT
TAG: create_transfer_direct

{
  "data": {
    "data": "{\"Result\":{\"ResponseStatus\":{\"ErrorCode\":500,\"IsSuccess\":false,\"Errors\":[{\"FieldName\":\"\",\"Message\":\"单据ZJDB231207000009的明细信息已存相同的外部原单编码JHDB23120500004外部原单明细ID:100147, 不允许保存!\",\"DIndex\":0}],\"SuccessEntitys\":[],\"SuccessMessages\":[],\"MsgCode\":11},\"Id\":\"\",\"Number\":\"\",\"NeedReturnData\":[{}]}}",
    "msg": "请求处理成功",
    "requestId": "4PL00001",
    "resultTopic": "FIN_ASYNC_RESULT_SIT",
    "status": 2,
    "resultTag": "create_transfer_direct"
  },
  "errorCode": 0,
  "isSuccess": true,
  "message": "成功"
}

异步接口对接指南

接口鉴权#

服务地址#

HTTP服务地址#

RocketMq服务地址与TOPIC#

请求#

响应#

异步请求发起#

异步请求结果获取#

请求参数#

请求示例#

响应参数#

响应示例#