公共服务

API列表

编号 API名称 路径 版本
1.1 根据父级地区编码查询下级区域 (保留) /tx/platform-biz/remac-tx-public/region/getRegionByCode 1.0
1.2 获取省市区三级树 （此接口后期将下线）请使用新的省市区三级树《优化后的获取省市区三级树》 (后期不再维护） /tx/platform-biz/remac-tx-public/region/getThreeLevelRegionTrees 1.0
1.2B 优化后的获取省市区三级树 （推荐使用） /tx/platform-biz/remac-tx-public/region/getFullTree 2.0
1.3 根据地区编码查询完整区域信息 (保留) /tx/platform-biz/remac-tx-public/region/getRegionMainByCode 1.0
1.4 根据地区编码查询父级完整区域信息 (保留) /tx/platform-biz/remac-tx-public/region/getParentRegionByCode 1.0
1.5 获取完整的省市区数据 （后期不再维护） /tx/platform-biz/remac-tx-public/region/queryCommonArea 1.0
1.6 根据areaId获取省市区地区信息 （保留） /tx/platform-biz/remac-tx-public/region/queryByAreaId 1.0
1.7 通过父级id获取区域列表 （保留） /tx/platform-biz/remac-tx-public/region/listByPid 1.0
1.8 获取可用的省市区列表(三级地址列表) （后期不再维护） /tx/platform-biz/remac-tx-public/region/listAreaOfEnable 1.0
2.1 根据关键字获取属性类型列表 /tx/platform-biz/remac-tx-public/enum/queryTypeByKeyword 1.0
2.2 根据类型获取枚举数据 /tx/platform-biz/remac-tx-public/enum/listByType 1.0
2.3 根据类型id删除枚举 /tx/platform-biz/remac-tx-public/enum/removeByTypeId 1.0
2.4 新增枚举类型 /tx/platform-biz/remac-tx-public/enum/addEnumType 1.0
2.5 修改枚举类型 /tx/platform-biz/remac-tx-public/enum/editEnumType 1.0
2.6 新增或修改枚举值 /tx/platform-biz/remac-tx-public/enum/updateEnumValueByType 1.0
3.1 文件上传 /tx/platform-biz/remac-tx-file/file/uploadFile 1.0
4 全局ID /tx/platform-biz/remac-id-generator/api/segment/get/{key}

API调用

1、行政区域

1.1: 根据父级地区编码查询下级区域

描述

每次获取一层，入参为空代表查询全国一级行政区域列表。最多到乡镇级别

请求信息

HTTP协议：HTTP,HTTPS

uri：/tx/platform-biz/remac-tx-public/region/getRegionByCode

HTTP头： bizToken

方法：POST/JSON

请求参数

名称 类型 必填 描述
regionCode String 否 regionCode：地区编码。依据当前的地区编码查询子集。为空代表查询全国一级行政区域列表。

请求Body描述

{

}
返回参数类型

JSON

返回参数

名称 类型 必填 描述
regionCode String 是 地区编码
regionName String 是 地区名称
parentCode String 否 父级地区编号
merName String 否 全路径名称
level String 是 级别(1省，2市，3区/县，4乡镇/街道)
返回结果示例
{
  "code": "200",
  "message": "请求成功",
  "data": [
    {
      "regionCode": "110000",
      "regionName": "北京",
      "parentCode": null,
      "merName": "中国,北京",
      "level": 1
    },
    {
      "regionCode": "120000",
      "regionName": "天津",
      "parentCode": null,
      "merName": "中国,天津",
      "level": 1
    }
    …
  ]
}

1.2: 获取省市区三级树(即将废弃)

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/tx/platform-biz/remac-tx-public/region/getThreeLevelRegionTrees

HTTP头： bizToken

方法：POST/JSON

请求参数

名称 类型 必填 描述
无

请求Body描述

{

}
返回参数类型

JSON

返回参数

名称 类型 必填 描述
regionCode String 是 地区编码
regionName String 是 地区名称
parentCode String 否 父级地区编号
merName String 是 全路径名称
children List 否 子级信息
返回结果示例
{
    "code": "200",
    "msg": "请求成功",
    "data": [{
            "treeId": "110000",
            "treePId": "100000",
            "leaf": false,
            "treeRemove": false,
            "children": [{
                "treeId": "110100",
                "treePId": "110000",
                "leaf": false,
                "treeRemove": true,
                "children": [{
                        "treeId": "110101",
                        "treePId": "110100",
                        "leaf": true,
                        "treeRemove": true,
                        "children": null,
                        "regionCode": "110101",
                        "regionName": "东城区",
                        "parentCode": "110100",
                        "merName": null
                    },
                    {
                        "treeId": "110102",
                        "treePId": "110100",
                        "leaf": true,
                        "treeRemove": true,
                        "children": null,
                        "regionCode": "110102",
                        "regionName": "西城区",
                        "parentCode": "110100",
                        "merName": null
                    }
                    ...
                ],
                "regionCode": "110100",
                "regionName": "北京市",
                "parentCode": "110000",
                "merName": null
            }],
            "regionCode": "110000",
            "regionName": "北京",
            "parentCode": "100000",
            "merName": null
        }
        ...
    ]
}

1.2B 优化后的获取省市区三级树

描述 为支持接口树型数据的灵活性，减少业务层的处理难度，支持自定义JSON格式。

请求信息

HTTP协议：HTTP,HTTPS

uri：/tx/platform-biz/remac-tx-public/region/getFullTree

HTTP头： bizToken

方法：GET

参数：

字段名 是否必填 类型 说明
key 否 字符串 自定义行政编码，默认为code。最大长度20.
value 否 字符串 自定义行政区域名称，默认为name。最大长度20.
children 否 字符串 自定义当前行政区域的子节点集合，默认为children。最大长度20.
status 否 Int 是否包含已作废的区域 ， 默认不包含。1: 不包含，缺省值。 2:包含。

请求示例：

/tx/platform-biz/remac-tx-public/region/getFullTree?key=code&value=name&children=children

返回示例：

{
  "code": "200",
  "data": [
    {
      "code": "110000",
      "name": "北京市"
      "children": [
        {
          "code": "110100",
          "children": [

            {
              "code": "110118",
              "name": "密云区",
              "status": 1
            },
            {
              "code": "110119",
              "name": "延庆区",
              "status": 1
            }
          ],
          "name": "市辖区",
          "status": 1
        }
      ] 
      }, 
      ... 
      ]
    }

返回status状态: 0 :停用，1:启用

1.3: 根据地区编码查询完整区域信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/tx/platform-biz/remac-tx-public/region/getRegionMainByCode

HTTP头： bizToken

方法：POST/JSON

请求参数

名称 类型 必填 描述
regionCode String 是 地区编码

请求Body描述

{
    "regionCode": "340000"
}
返回参数类型

JSON

返回参数

名称 类型 必填 描述
regionCode String 是 地区编码
regionName String 是 地区名称
parentCode String 是 父级地区编号
merName String 是 全路径名称
simpleName String 是 简称
level Integer 是 级别(1省，2市，3区/县，4乡镇/街道)
lng Double 是 经度
lat Double 是 纬度
pinyin String 是 拼音
status Integer 是 启用状态：0停用，1启用
返回结果示例
{
    "code": "200",
    "message": "请求成功",
    "data": {
        "regionId": 1048,
        "regionCode": "340000",
        "regionName": "安徽省",
        "parentCode": "100000",
        "simpleName": "安徽",
        "level": 1,
        "cityCode": "",
        "zipCode": "",
        "merName": "中国,安徽省",
        "lng": 117.283,
        "lat": 31.8612,
        "pinyin": "Anhui",
        "status": 1
    }
}

1.4: 根据地区编码查询父级完整区域信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/tx/platform-biz/remac-tx-public/region/getParentRegionByCode

HTTP头： bizToken

方法：POST/JSON

请求参数

名称 类型 必填 描述
regionCode String 是 地区编码

请求Body描述

{
    "regionCode": "110101"
}
返回参数类型

JSON

返回参数

名称 类型 必填 描述
regionCode String 是 地区编码
regionName String 是 地区名称
parentCode String 是 父级地区编号
merName String 是 全路径名称
simpleName String 是 简称
level Integer 是 级别(1省，2市，3区/县，4乡镇/街道)
lng Double 是 经度
lat Double 是 纬度
pinyin String 是 拼音
status Integer 是 启用状态：0停用，1启用
返回结果示例
{
    "code": "200",
    "message": "请求成功",
    "data": {
        "regionId": 4,
        "regionCode": "110100",
        "regionName": "北京市",
        "parentCode": "110000",
        "simpleName": "北京",
        "level": 2,
        "cityCode": "010",
        "zipCode": "100000",
        "merName": "中国,北京,北京市",
        "lng": 116.405,
        "lat": 39.905,
        "pinyin": "Beijing",
        "status": 1
    }
}

1.5: 获取完整的省市区数据

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/tx/platform-biz/remac-tx-public/region/queryCommonArea

HTTP头： bizToken

方法：POST/JSON

请求参数

名称 类型 必填 描述
areaId String 否 地区编码
areaName String 否 地址名称
parentId String 否 上级地址编号
level Integer 否 等级（从1开始）

请求Body描述

{
    "areaName":"区",
    "level":2,
    "parentId":540000
}
返回参数类型

JSON

返回参数

名称 类型 必填 描述
areaId Long 是 地区编码
areaName String 是 地区名称
parentId Long 是 父级地区编号
level Integer 是 级别(1省，2市，3区/县，4乡镇/街道)
返回结果示例
{
    "code": "200",
    "message": "请求成功",
    "data": [
        {
            "areaId": 542200,
            "areaName": "山南地区",
            "parentId": 540000,
            "level": 2,
            "check": null,
            "areas": null,
            "areaIds": null
        },
        {
            "areaId": 542400,
            "areaName": "那曲地区",
            "parentId": 540000,
            "level": 2,
            "check": null,
            "areas": null,
            "areaIds": null
        },
        {
            "areaId": 542500,
            "areaName": "阿里地区",
            "parentId": 540000,
            "level": 2,
            "check": null,
            "areas": null,
            "areaIds": null
        },
        {
            "areaId": 542600,
            "areaName": "林芝地区",
            "parentId": 540000,
            "level": 2,
            "check": null,
            "areas": null,
            "areaIds": null
        }
    ]
}

1.6: 根据areaId获取省市区地区信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/tx/platform-biz/remac-tx-public/region/queryByAreaId

HTTP头： bizToken

方法：GET

请求参数

名称 类型 必填 描述
areaId Long 是 地区编码

请求Body描述

GET /region/queryByAreaId?areaId=542200
返回参数类型

JSON

返回参数

名称 类型 必填 描述
areaId Long 是 地区编码
areaName String 是 地区名称
parentId Long 是 父级地区编号
level Integer 是 级别(1省，2市，3区/县，4乡镇/街道)
返回结果示例
{
    "code": "200",
    "message": "请求成功",
    "data": {
        "areaId": 542200,
        "areaName": "山南地区",
        "parentId": 540000,
        "level": 2,
        "check": null,
        "areas": null,
        "areaIds": null
    }
}

1.7: 通过父级id获取区域列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/tx/platform-biz/remac-tx-public/region/listByPid

HTTP头： bizToken

方法：GET

请求参数

名称 类型 必填 描述
pid Long 是 父级地区编码

请求Body描述

GET /region/queryByAreaId?pid=542200
返回参数类型

JSON

返回参数

名称 类型 必填 描述
areaId Long 是 地区编码
areaName String 是 地区名称
parentId Long 是 父级地区编号
level Integer 是 级别(1省，2市，3区/县，4乡镇/街道)
返回结果示例
  {
    "code": "200",
    "message": "请求成功",
    "data": [
        {
            "areaId": 542221,
            "areaName": "乃东县",
            "parentId": 542200,
            "level": 3,
            "check": null,
            "areas": null,
            "areaIds": null
        },
        {
            "areaId": 542222,
            "areaName": "扎囊县",
            "parentId": 542200,
            "level": 3,
            "check": null,
            "areas": null,
            "areaIds": null
        }
    ]
}

1.8: 获取可用的省市区列表（三级地址列表）

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/tx/platform-biz/remac-tx-public/region/listAreaOfEnable

HTTP头： bizToken

方法：POST/JSON

请求参数

名称 类型 必填 描述
无

请求Body描述
返回参数类型

JSON

返回参数

名称 类型 必填 描述
areaId Long 是 地区编码
areaName String 是 地区名称
parentId Long 是 父级地区编号
level Integer 是 级别(1省，2市，3区/县，4乡镇/街道)
返回结果示例
  {
    "code": "200",
    "message": "请求成功",
    "data": [
        {
            "areaId": 542221,
            "areaName": "乃东县",
            "parentId": 542200,
            "level": 3,
            "check": null,
            "areas": null,
            "areaIds": null
        },
        {
            "areaId": 542222,
            "areaName": "扎囊县",
            "parentId": 542200,
            "level": 3,
            "check": null,
            "areas": null,
            "areaIds": null
        }
    ]
}

2、枚举管理

2.1: 根据关键字获取属性类型列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/tx/platform-biz/remac-tx-public/enum/queryTypeByKeyword

HTTP头： bizToken

方法：POST/JSON

请求参数

名称 类型 必填 描述
keyword String 否 关键字

请求Body描述

{
    "keyword":"商品"
}
返回参数类型

JSON

返回参数

名称 类型 必填 描述
id Long 是 枚举类型id
enumTypeName String 是 枚举类型名称
enumTypeDesc String 是 枚举类型描述
返回结果示例
{
    "code": "200",
    "message": "请求成功",
    "data": [
        {
            "id": "1",
            "enumTypeName": "属性枚举",
            "enumTypeDesc": "商品属性枚举"
        }
    ]
}

2.2: 根据类型获取枚举数据

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/tx/platform-biz/remac-tx-public/enum/listByType

HTTP头： bizToken

方法：GET

请求参数

名称 类型 必填 描述
typeId Long 是 类型id

请求描述

http://ip:port/tx/platform-biz/remac-tx-public/enum/listByType?typeId=1
返回参数类型

JSON

返回参数

名称 类型 必填 描述
enumName String 是 属性名称
enumValue String 是 属性值
返回结果示例
{
    "code": "200",
    "message": "请求成功",
    "data": [
        {
            "enumName": "销售属性",
            "enumValue": "sale"
        },
        {
            "enumName": "基础属性",
            "enumValue": "base"
        },
        {
            "enumName": "特殊属性",
            "enumValue": "special"
        }
    ]
}

2.3: 根据类型id删除枚举

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/tx/platform-biz/remac-tx-public/enum/removeByTypeId

HTTP头： bizToken

方法：POST/JSON

请求参数

名称 类型 必填 描述
typeId Long 是 类型id

请求描述

{
    "typeId":2
}
返回参数类型

JSON

返回参数

名称 类型 必填 描述
无
返回结果示例
{
    "code": "200",
    "message": "请求成功",
    "data": null
}

2.4: 新增枚举类型

描述

枚举类型名称会做重名校验

请求信息

HTTP协议：HTTP,HTTPS

uri：/tx/platform-biz/remac-tx-public/enum/addEnumType

HTTP头： bizToken

方法：POST/JSON

请求参数

名称 类型 必填 描述
enumTypeName String 是 枚举类型名称
enumTypeDesc String 是 枚举类型描述

请求描述

{
    "enumTypeName":"通用颜色",
    "enumTypeDesc":"通用颜色"
}
返回参数类型

JSON

返回参数

名称 类型 必填 描述
data Long 是 类型id
返回结果示例
{
    "code": "200",
    "message": "请求成功",
    "data": 4
}

2.5: 修改枚举类型

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/tx/platform-biz/remac-tx-public/enum/editEnumType

HTTP头： bizToken

方法：POST/JSON

请求参数

名称 类型 必填 描述
id Long 是 枚举类型id
enumTypeName String 是 枚举类型名称
enumTypeDesc String 是 枚举类型描述

请求描述

{
    "id":4,
    "enumTypeName":"通用颜色",
    "enumTypeDesc":"通用颜色"
}
返回参数类型

JSON

返回参数

名称 类型 必填 描述
无
返回结果示例
{
    "code": "200",
    "message": "请求成功",
    "data": null
}

2.6: 新增或修改枚举值

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/tx/platform-biz/remac-tx-public/enum/updateEnumValueByType

HTTP头： bizToken

方法：POST/JSON

请求参数

名称 类型 必填 描述
typeId Long 是 枚举类型id
enumName String 是 枚举名称
enumValue String 是 枚举代号
orderNo Integer 是 排序顺序

请求描述

{
    "typeId":2,
    "enumList":[
        {
            "enumName":"红色",
            "enumValue":"red",
            "orderNo":1
        },
         {
            "enumName":"黑色",
            "enumValue":"black",
            "orderNo":2
        }
    ]
}
返回参数类型

JSON

返回参数

名称 类型 必填 描述
无
返回结果示例
{
    "code": "200",
    "message": "请求成功",
    "data": null
}

3 文件上传

3.1: 文件上传

上传均使用此接口

描述：

上传单个文件

HTTP协议：

HTTP,HTTPS

URL:

/tx/platform-biz/remac-tx-file/file/uploadFile

HTTP头：

remacToken/iotaccounttoken

方法：

POST

路径参数：

名称 类型 必填 描述
filePart FilePart 是 文件
sourceTypeCode Integer 否 文件来源系统（0：天策 1：天工 2：运营管理平台 3：中台）（默认10000）

返回：

{
  "code": "200",
  "message":"success",
  "data": 下载/预览链接url
}

4 获取全局ID

描述： 开具电子发票与红冲电子发票均使用该接口。

URL: /tx/platform-biz/remac-id-generator/api/segment/get/{key}

方法： POST

HTTP头： bizToken / remacToken

方法：POST

路径参数: key: 必传，业务系统标识枚举值

业务系统标识枚举值可以参见下表：

业务系统标识枚举值。 如有新的业务，请协助文档维护者更新。

值 意义
tx-biz-merchandise 天选商品中心
tx-biz-order 天选订单中心
tx-biz-tiance 天策
tx-biz-tiangong 天工

返回：

{
  "code": "200",
  "data": "2003",
  "message": "success"
}

其中： data值为分布式系统中的依据具体的业务获取的唯一ID 。

Copyright © www.remacsmart.com/ 2021 all right reserved，powered by Gitbook该文件修订时间： 2023-12-13 16:08:34

results matching ""

    No results matching ""