中台向外部系统拉数据API接口文档

文档说明： 业务系统向中台同步数据中途有可能存在网络故障、中台应用程序BUG等原因导致数据未能及时同步过来，为避免业务系统向中台“推”数据不成功，各业务系统提供相关的查询接口以便让中台“拉”数据，最大程度地保证中台数据的准确性与实时性。

使用对象： 仅限中台内部使用。

中台调用业务方接口请求需要经中台内部网关，见下图：

编号 API名称 路径 版本
1.1 查询服务产品信息 /admin/sync_data/center 1.0
1.2 查询业务工单信息 /admin/sync_data/center 1.0
2.1 客户数据同步 /sky-planning/v1/test/customer/async 1.0
2.2 获取客户完整数据 /sky-planning/v1/test/customer/get 1.0
2.3 方案数据同步 /sky-planning/v1/test/layout/async 1.0
2.4 获取方案完整数据 /sky-planning/v1/test/layout/get 1.0
3.1 同步已完成订单信息 /bizPlatform/order/asyncOrderData 1.0
3.2 查询完整订单数据 /bizPlatform/order/queryOrderAllData 1.0
3.3 同步商品信息至kafka /bizPlatform/product/asyncProductData 1.0
3.4 查询完整的商品信息 /bizPlatform/product/queryProductAllData 1.0
3.5 同步品牌信息至kafka /bizPlatform/brand/asyncBrandData 1.0
3.6 查询完整品牌信息 /bizPlatform/brand/queryBrandAllData 1.0
3.7 同步品牌分类至kafka /bizPlatform/category/asyncCategoryData 1.0
3.8 查询完整分类信息 /bizPlatform/category/queryCategoryAllData 1.0

1 中台向天工方拉数据接口

1.1 查询服务产品信息

(此接口为公网请求, 请求体需加签名)

请求信息

HTTP协议：HTTPS

uri: /admin/sync_data/center

host(dev): https://tg-api-dev.remacsmart.com

方法: POST

请求参数

名称 类型 必填 描述
type string Y 固定值: service_product_query
timestamp long Y 时间戳
data object Y 请求参数
mac 请求体签名 Y HttpSignUtil.sign()对当前请求体签名串

data里的参数

名称 类型 必填 描述
id long Y skuId

请求体示例: 

{
  "data": {
    "id": 2700
  },
  "type": "service_product_query",
  "mac": "9032576abf59bfb09b435d5a74ad69172745c7b68916221cf19cf1b5e9a242b8",
  "timestamp": 1687854768290
}

返回参数

返回参数说明:

名称 类型 必填 描述
serviceProductId string Y 服务产品标识
serviceProductName string Y 服务产品名称
price long Y 服务产品价格
count int N 服务产品数量
dealerFee long Y 品牌方服务费用
dealerToDoorFee long Y 品牌商服务上门费用
status bool Y 启用状态: true-启用, false-停用

返回结果示例:

{
    "code": "200",
    "data": [
        {
            "dealerFee": 1,
            "dealerToDoorFee": 1,
            "deleteFlag": false,
            "price": 2,
            "serviceProductId": 552,
            "serviceProductName": "安装智能家居",
            "status": true
        },
        {
            "dealerFee": 1,
            "dealerToDoorFee": 1,
            "deleteFlag": false,
            "price": 2,
            "serviceProductId": 553,
            "serviceProductName": "安装调试智慧中控",
            "status": true
        }
    ],
    "message": "success",
    "mac": "d086edaea8658aaaadadef37c8fccd50053dd43202c2cc1677cb781dac0043b2"
}

1.2 查询业务工单信息

(此接口为公网请求, 请求体需加签名)

请求信息

HTTP协议：HTTPS

uri：/admin/sync_data/center

host(dev): https://tg-api-dev.remacsmart.com

方法: POST

请求参数

名称 类型 必填 描述
type string Y 固定值: biz_order_query
timestamp long Y 时间戳
data object Y 请求参数
mac 请求体签名 Y HttpSignUtil.sign()对当前请求体签名串

data里的参数

名称 类型 必填 描述
businessNo string Y 业务单号

请求体示例:

{
  "data": {
    "businessNo":"YWD20230428000004"
  },
  "type": "biz_order_query",
  "mac": "0d61888f91b2f28ea42d54102636aba2465e9e2fd730bba82716468066c974e7",
  "timestamp": 1686736141202
}

返回结果示例:

{
    "code": "200",
    "data": {
        "businessOrder": {
            "accounTime": null,
            "address": "天津市和平区劝业场街道上升",
            "appointmentTime": "",
            "brandSideId": 90307229,
            "brandSideName": "427品牌方",
            "businessNo": "YWD20230428000004",
            "cancelInfo": "sdf",
            "comunityName": "测试项目111",
            "createTime": "2023-04-28 14:08:15",
            "creater": "admin",
            "customType": 10,
            "dealTime": "2023-04-28 14:08:15",
            "exceptionInfo": "提尔石头人",
            "expectedServiceTime": null,
            "finishTime": null,
            "id": 1,
            "isAbnormal": 1,
            "isDelete": 1,
            "layoutId": 11,
            "managerName": "测试11",
            "merName": "中国,天津,天津市,和平区,劝业场街道,上升",
            "mobile": "13150000001",
            "orderList": [
                {
                    "actualFinishNum": 0,
                    "address": "天津市和平区劝业场街道上升",
                    "adjustFee": null,
                    "adjustReason": "",
                    "appointmentTime": "2023-05-05 20:00-21:00",
                    "assignStatus": "自动指派失败",
                    "businessNo": "YWD20230428000004",
                    "cancelDetail": "",
                    "cancelReason": "",
                    "createTime": "2023-05-08 14:08:15",
                    "creater": "admin",
                    "engineerAcount": "ENG-13006644681",
                    "engineerName": "工程师1",
                    "exceptionInfo": "",
                    "expectedServiceTime": null,
                    "expressNo": "",
                    "finalFee": null,
                    "id": 1,
                    "isAbnormal": null,
                    "isDelete": 1,
                    "isIntact": 1,
                    "merName": "中国,天津,天津市,和平区,劝业场街道,上升",
                    "mobile": "13150000001",
                    "orderNo": "GD20230428000004",
                    "orderStatus": "已取消",
                    "ownerMsg": "",
                    "ownerName": "上升",
                    "ownerNo": "YZ20230428000004",
                    "pauseReason": "",
                    "processInstanceId": "10381975-e58b-11ed-ae9f-8e5bafb9eed0",
                    "processKey": "p184312-322ae0dc-1a9",
                    "regionCode": "120101001",
                    "releaseTime": null,
                    "remark": "",
                    "requiredFinishNum": 1,
                    "serviceCode": "5693f04c-b4c3-4ba1-8f46-189bf4468b25",
                    "serviceProductName": "427导入服务产品",
                    "serviceType": "427服务类型",
                    "sideAcount": "FWS-13145231417",
                    "sideName": "服务商-ljx",
                    "standardsName": "427规格",
                    "statusId": 99,
                    "updateTime": "2023-05-11 09:46:39",
                    "updater": "admin"
                }
            ],
            "orderType": null,
            "ownerMsg": "",
            "ownerName": "上升",
            "ownerNo": "YZ20230428000004",
            "projectAccount": "测试项目1111栋1单元1楼1房",
            "publishStatus": 10,
            "qrCode": "tg-4cffa5aba6d644e0a0460cc01c6d2d86",
            "regionCode": "120101001",
            "releaseTime": "2023-04-28 14:08:15",
            "remark": "",
            "settlementTime": null,
            "sourceId": 2,
            "sourceName": "427业务单来源",
            "status": "0",
            "statusCount": 0,
            "statusTime": "2023-05-11 09:46:39",
            "txOrderId": null,
            "updateTime": "2023-06-15 08:18:38",
            "updater": "admin"
        }
    },
    "mac": "54ba1d0b857f6d79490886abb925022d33c8551b4a71b92866ea12aa5644edca",
    "message": "success"
}

2 中台向天策方拉数据接口

2.1: 客户数据同步

(由中台方调用触发同步天策的客户数据至中台)

请求信息

HTTP协议：HTTP,HTTPS

uri：/sky-planning/v1/test/customer/async

HTTP头： bizToken

方法：GET

请求参数

名称 类型 必填 描述
customerId Long 否 客户id(不传该参数则全量同步，传参则只同步当前客户数据)。 初始化时才同步全量数据。

请求示例


GET https://ip:port/sky-planning/v1/test/customer/async?customerId=67

返回参数

参考客户中心数据同步消息说明

2.2: 获取客户完整数据

请求信息

HTTP协议：HTTP,HTTPS

uri：/sky-planning/v1/test/customer/get

HTTP头： bizToken

方法：GET

请求参数

名称 类型 必填 描述
customerId Long 是 客户id

请求示例


GET https://ip:port/sky-planning/v1/test/customer/get?customerId=67

返回参数

参考客户中心数据同步消息说明

2.3: 方案数据同步

请求信息

HTTP协议：HTTP,HTTPS

uri：/sky-planning/v1/test/layout/async

HTTP头： bizToken

方法：GET

请求参数

名称 类型 必填 描述
layoutId Long 否 方案主键id(不传该参数则全量同步，传参则只同步当前数据)

请求示例


GET https://ip:port/sky-planning/v1/test/layout/async?layoutId=67

返回参数

参考方案中心数据同步消息说明

2.4: 获取方案完整数据

请求信息

HTTP协议：HTTP,HTTPS

uri：/sky-planning/v1/test/layout/get

HTTP头： bizToken

方法：POST

请求参数

名称 类型 必填 描述
layoutId Long 是 方案主键id

请求示例


POST https://ip:port/sky-planning/v1/test/layout/get?layoutId=67

返回参数

参考方案中心数据同步消息说明

3 中台向天选方拉数据接口

3.1: 同步已完成订单信息

请求信息

HTTP协议：HTTP,HTTPS

uri：/bizPlatform/order/asyncOrderData

HTTP头： bizToken

方法：GET

请求参数

名称 类型 必填 描述
orderThirdId Long 否 订单id(不传则全量同步，传则只查询当前数据)

请求示例


GET https://ip:port/bizPlatform/order/asyncOrderData?orderThirdId=450512621568

返回参数

参考天选商城订单中心数据同步消息说明

3.2: 查询完整订单数据

请求信息

HTTP协议：HTTP,HTTPS

uri：/bizPlatform/order/queryOrderAllData

HTTP头： bizToken

方法：POST/JSON

请求参数

名称 类型 必填 描述
orderThirdId Long 是 订单id

请求示例


{
  "orderThirdId":123837372
}

返回参数

参考天选商城订单中心数据同步消息说明

3.3: 同步商品信息至kafka

请求信息

HTTP协议：HTTP,HTTPS

uri：/bizPlatform/product/asyncProductData

HTTP头： bizToken

方法：GET

请求参数

名称 类型 必填 描述
spuId Long 否 spuId(不传则全量同步，传则同步当前数据)

请求示例


GET https://ip:port/bizPlatform/product/asyncProductData?spuId=450512621568

返回参数

参考天选商城产品中心数据同步消息说明

3.4: 查询完整的产品信息

请求信息

HTTP协议：HTTP,HTTPS

uri：/bizPlatform/product/queryProductAllData

HTTP头： bizToken

方法：GET

请求参数

名称 类型 必填 描述
spuId Long 是 spuId

请求示例


GET https://ip:port/bizPlatform/product/queryProductAllData?spuId=450512621568

返回参数

参考天选商城产品中心数据同步消息说明

3.5: 同步品牌信息至kafka

请求信息

HTTP协议：HTTP,HTTPS

uri：/bizPlatform/brand/asyncBrandData

HTTP头： bizToken

方法：GET

请求参数

名称 类型 必填 描述
brandId Long 否 brandId(不传则全量同步，传则同步当前数据)

请求示例


GET https://ip:port/bizPlatform/brand/asyncBrandData?brandId=3

返回参数

参考天选商城品牌数据同步消息说明

3.6: 查询完整品牌信息

请求信息

HTTP协议：HTTP,HTTPS

uri：/bizPlatform/brand/queryBrandAllData

HTTP头： bizToken

方法：GET

请求参数

名称 类型 必填 描述
brandId Long 是 brandId

请求示例


GET https://ip:port/bizPlatform/brand/queryBrandAllData?brandId=3

返回参数

参考天选商城品牌数据同步消息说明

3.7: 同步分类信息至kafka

请求信息

HTTP协议：HTTP,HTTPS

uri：/bizPlatform/brand/asyncCategoryData

HTTP头： bizToken

方法：GET

请求参数

名称 类型 必填 描述
categoryId Long 否 categoryId(不传则全量同步，传则同步当前数据)

请求示例


GET https://ip:port/bizPlatform/category/asyncCategoryData?categoryId=3

返回参数

参考天选商城分类数据同步消息说明

3.8: 查询完整分类信息

请求信息

HTTP协议：HTTP,HTTPS

uri：/bizPlatform/brand/queryCategoryAllData

HTTP头： bizToken

方法：GET

请求参数

名称 类型 必填 描述
categoryId Long 是 categoryId

请求示例


GET https://ip:port/bizPlatform/queryCategoryAllData?categoryId=3

返回参数

参考天选商城分类数据同步消息说明

Copyright © www.remacsmart.com/ 2021 all right reserved，powered by Gitbook该文件修订时间： 2023-07-05 11:34:06

results matching ""

    No results matching ""