集成配置接口


系统集成管理/应用管理配置

新增/更新集成配置

  • 接口描述:对于系统集成管理或应用管理配置进行api配置保存接口
  • 接口地址:/api/v1/base/open/app/config/save?token=TOKEN
  • 请求方式:POST
  • Content-Type: multipart/form-data
  • 接口入参
    参数名 必须 参数类型 参数说明
    productId int 0:自用 1:平台id,在开放管理内获取
    cfgKey String 集成管理业务key 1002:自主用户系统 1006:互动-自定义规则 1012:互动-自定义抽奖次数 1004: 页面集成
    cfgId Long 规则id 可选传参:若可以针对业务 key可以配置多条的 更新时需要传此字段(比如抽奖规则)
    value String json数据配置 各种类型的配置json格式不一样 具体看下面的json实际举例

    查询集成配置

  • 接口描述:查询集成配置
  • 接口地址:/api/v1/base/param/params?token=TOKEN
  • 请求方式:POST
  • Content-Type: multipart/form-data
  • 接口入参
    参数名 必须 参数类型 参数说明
    key String 集成管理业务key 1002:自主用户系统 1006:互动-自定义规则 1012:互动-自定义抽奖次数 1004: 页面集成 1504:自定义脚本(JS)
{
    "success": true,
    "code": "200",
    "msg": null,
    "obj": null,
    "map": null,
    "list": [{
        "id": 5031,
        "key": "1006",
        "value": "{\"ruleName\":\"哈哈\",\"apiUrl\":\"http://www.eqxiu.com\"}",
        "remark": null,
        "relType": "PRODUCT",
        "relId": "1001",
        "sort": 2,
        "saveTime": "2021-08-19 12:04:49",
        "default": false
    }],
    "details": null
}

删除指定集成配置

  • 接口描述:删除集成配置
  • 接口地址:/api/v1/base/open/app/config/delete?token=TOKEN
  • 请求方式:POST
  • Content-Type: multipart/form-data
  • 接口入参
    参数名 必须 参数类型 参数说明
    productId int 0:自用 1:平台id,在开放管理内获取
    cfgId Long 规则id

各种场景配置实例举例

自主用户系统

{
    "id":123,
    "sysName": "系统名称",
    "authorizeUrl": "http://www.xx.com/xyz",
    "userGetUrl": "http://www.xx.com"
}
id:cfgId
sysName:系统名称 
authorizeUrl:授权页地址
userGetUrl:用户信息获取接口地址 

互动-自定义抽奖规则


像上述配置 的传参如下

{
    "ruleName": "规则名称1",
    "apiUrl": "http://wxwork.yqxiu.cn/cmpdemo/custom/lottery",
    "consume": [{
        "type": 1,
        "name": "资源一",
        "paramName": "r1",
        "default": "3",
        "max": "10",
        "min": "1",
        "required": false,
        "checkInfo": {
            "name": "",
            "paramName": "",
            "default": "",
            "max": "",
            "min": "",
            "type": "",
            "required": "",
            "checkInfo": ""
        }
    }],
    "threshold": [{
        "type": 1,
        "name": "门槛一",
        "paramName": "t1",
        "default": "2",
        "max": "3",
        "min": "1",
        "required": false,
        "checkInfo": {
            "name": "",
            "paramName": "",
            "default": "",
            "max": "",
            "min": "",
            "type": "",
            "required": "",
            "checkInfo": "",
            "options": ""
        },
        "options": [{
            "label": "",
            "value": "",
            "required": false,
            "checkInfo": {
                "label": "",
                "value": ""
            }
        }]
    }],
    "thirdLimitV2": "0"
}

ruleName:规则名称
apiUrl:规则地址
consume:抽奖消耗配置
threshold:

互动-自定义抽奖次数


像上述配置 的传参如下

{
    "id":123
    "ruleName": "自定义次数",
    "apiUrl": "http://wxwork.yqxiu.cn/cmpdemo/custom/lottery/count",
    "tip": "次数不足"
}

ruleName:规则名称
apiUrl:规则地址
tip:次数不够的提示语

页面集成

{
    "url": "",
    "exitUrl": "https://www.eqxiu.cn/creation?eventType=quit",
    "publishUrl": "https://www.eqxiu.cn/creation?eventType=publish"
}

url:登录失效时跳转的地址
publishUrl:从编辑器点击发布后,页面跳转地址
exitUrl:从编辑器点击退出后,页面跳转地址


will 2023年8月14日 10:40 4321 收藏文档