活动资格接口鉴权

概述：

编辑器对活动主办方提供针对用户是否具有参与资格、作品访问资格、领取奖品资格等提供鉴权。此功能中活动h5会发送自定义鉴权参数到对应鉴权接口（见下方鉴权接口协议部分）进行鉴权，具体接口需要主办方自行实现。

我需要准备什么？

本授权功能需接入方企业先在营销云开通 “数据集成” 模块，并获得 “自建应用” 的使用权限。
自建应用内申请开通编辑器 → 自定义接口鉴权，后续联系管理员审核通过。应用配置界面如下：

添加后，点击“编辑”进入对应设置页

注意：此处如果需要自定义外部的校验参数，需勾选”外部接口回调“选项进行配置，具体配置如下
完成配置后，点击“保存”即可。
在编辑器中，可在作品预览页面开启作品访问限制鉴权，或在活动玩法配置中对应限制选项中进行配置，配置界面如下：
此配置案例下，在用户访问作品时，会调用主办方配置的鉴权接口，发送在数据集成自定义接口鉴权中配置好的字段，通过接口返回结果来判断用户是否具有作品访问资格。

外部接口鉴权api参数说明

外部接口

请求方法

请求参数

返回结构

请求示例

获取鉴权条件

GET

-

{
	"code": "200",
	"msg": "ok",
	"data": [
		{
			"label": "范围",
			"type": "area",
			"value": "",
			"children": [
				{
					"value": "80"
				},
				{
					"value": "100"
				}
			]
		},
		{
			"label": "性别",
			"type": "checkbox",
			"value": "",
			"children": [
				{
					"label": "男",
					"value": "1"
				},
				{
					"label": "女",
					"value": "2"
				}
			]
		},
		{
			"label": "部门",
			"value": "",
			"type": "select",
			"children": [
				{
					"label": "A部门",
					"value": "a"
				},
				{
					"label": "B部门",
					"value": "b"
				},
				{
					"label": "C部门",
					"value": "c"
				}
			]
		},
		{
			"label": "年龄",
			"type": "number",
			"value": "18",
			"children": []
		},
		{
			"label": "分类",
			"type": "cascader",
			"value": "",
			"children": [
				{
					"label": "项目分组",
					"value": "project_group",
					"children": [
						{
							"label": "新客户",
							"value": "1"
						},
						{
							"label": "未成交老客户",
							"value": "2"
						}
					]
				},
				{
					"label": "经纪人分组",
					"value": "broker_group",
					"children": [
						{
							"label": "自由合伙人",
							"value": "9004"
						},
						{
							"label": "代理公司",
							"value": "9003"
						}
					]
				}
			]
		}
	]
}

参数说明

label：标签名称

value：标签值

type：文本 text,数值 number,多选 select,单选 checkbox,区间 area ,级联 cascader

children：子集（只有在级联、多选、单选、区间类型时才不为空）

https://editor.test.rabbitpre.com/api/editor/proxy/thirddata/api/xxx/cms/getAuthConditions

保存通知接口

POST

字段名称	字段类型	是否必传	字段说明
userId	string	true	当前用户id。透传到客户侧的参数
componentId	string	false	当前作品下玩法组件ID。透传到客户侧的参数
appId	string	false	兔展作品ID。透传到客户侧的参数，该值是否一定有值和作品（玩法）的保存顺序有关
authScope	number	true	默认值 0。 0：玩法资格配置， 1：作品访问限制资格配置， 2：流程策略资格配置
externalConfigId	string	false	外部配置id（传空代表新增配置，不为空代表修改配置）。也即该接口响应返回的configId字段值
settingData	Array<Object>	false
└─ label	string	true	名称
└─ name	string	true	标识
└─ value	Object	true	值。不同的type值对应不同数据格式的value，参考示例。type为text、number的value值是string
└─ type	string	false	文本 text,数值 number,多选 select,单选 checkbox,区间 area ,级联 cascader
└─ operator	string	false	ALL : 全部，IN : 其中之一， EQ : 等于，GT : 大于，GTEQ : 大于等于，LT : 小于，LTEQ : 小于等于，NEQ ：不等于。type为非cascader、select、number时为空
sceneType	string	false	玩法类型： Award-领奖，Lottery-抽奖，Help-助力，Team-组队，Reserve-预约，Signin-签到，Question-问卷，Answer-答题，Vote-投票，Game-游戏，Task-任务，Points-积分，Seckill-秒杀，GroupBuying-拼团，Tzappid-作品级

{
	"code:" 200,
	"data": {
		// 外部接口返回的配置id
		"configId": "aaa-bbb-ccc"
	}
}

https://editor.test.rabbitpre.com/api/editor/proxy/thirddata/api/xxx/cms/saveNotice

入参：

{
  "settingData": [
    {
      "label": "职业文本",
      "type": "text",
      "name": "professiontext",
      "value": "文本的值"
    },
    {
      "label": "用户身份数值",
      "type": "number",
      "name": "userFlagNumber",
      "operator": "EQ",
      "value": "9527"
    },
    {
      "label": "性别",
      "type": "select",
      "name": "gender",
      "operator": "IN",
      "value": [
        "1"
      ]
    },
    {
      "label": "是否新客户",
      "type": "checkbox",
      "name": "isCustomer",
      "value": "1"
    },
    {
      "label": "人生阶段",
      "type": "select",
      "name": "lifeStage",
      "operator": "IN",
      "value": [
        "1",
        "2",
        "3",
        "4"
      ]
    },
    {
      "label": "城市",
      "type": "cascader",
      "name": "city",
      "operator": "IN",
      "value": [
        {
          "label": "北京市",
          "value": "北京市",
          "type": null,
          "children": [
            {
              "label": "北京市",
              "value": "北京市",
              "type": null,
              "children": null
            }
          ]
        },
        {
          "label": "天津市",
          "value": "天津市",
          "type": null,
          "children": [
            {
              "label": "天津市",
              "value": "天津市",
              "type": null,
              "children": null
            }
          ]
        }
      ]
    }
  ],
  "externalConfigId": "",
  "userId": "2a40a6c6-7379-4961-9088-cb9a071f3a55",
  "componentId": "31bc2f36-c5de-4c34-adf6-c967a92561b8",
  "sceneType": "Tzappid",
  "appId": "31bc2f36-c5de-4c34-adf6-c967a92561b8",
  "authScope": 1
}

鉴权接口协议：

鉴权接口完整URL：自建应用方自己的 domain+URI

例如： https://aa.bb.com/api/xx/checkUserAuth

接口协议：HTTPS

HTTP请求方式：POST

consumes ：application/json

produces ：application/json

接口响应时间：3秒以内，最好能达到百毫秒级，满足高并发场景。活动H5方调用鉴权接口最多等待3秒，超过3秒没有响应，自动放弃请求，判定为鉴权失败。

接口参数说明表：

字段名称	字段类型	是否必传	字段说明
interfaceName	string	true	接口鉴权名称
checkType	string	false	校验类型: false:自定义设置 true:外部接口回调
externalConditionUrl	string	false	外部接口回调-获取鉴权条件URL
externalInformUrl	string	false	外部接口回调-保存通知接口
externalConfigId	string	false	外部接口配置的ID
userParam	Object	true	用户参数。对应自建应用中的系统参数中的固定参数
└─ audid	string	true	客户档案id
└─ openid	string	false	openid
└─ appId	string	true	作品id
└─ componentId	string	false	组件id
└─ flowId	string	false	流程策略id
└─ appInstanceId	string	false	自建应用的id
└─ identityId	string	false	自建应用的识别的身份id
└─ identityType	string	false	自建应用的身份类型
└─ realName	string	false	真实姓名
└─ phone	string	false	手机号码
└─ address	string	false	地址信息
└─ device	string	false	手机型号 ios/Android
└─ markFlag	integer	false	是否星标 1是 0否
└─ payFeature	string	false	消费特点
└─ sex	integer	false	性别 1男 2女
└─ identitys	Array	false	用户多身份信息
└─ identityId	string	false	自建应用的识别的身份id。platform=EXTERNAL（自建应用）
└─ identityType	string	false	自建应用的身份类型。platform=EXTERNAL（自建应用）
└─ fromTo	string	false	标识来源
└─ platform	string	false	标识来源平台。平台标识，gzh（微信公众号）、contentminiapp（微信小程序）、EXTERNAL（自建应用）
└─ openid	string	false	openid （当 fromTo 为 gzh（微信公众号）时，openid有值）
└─ unionid	string	false	unionid （当 fromTo 为 gzh（微信公众号）时，unionid有值）
└─ jcappid	Long	true	系统集成Id
└─ appid	string	false	公众号appid
└─ customFields	Array	false	自定义字段可能会存在多个。对应工作台中的用户-字段管理中的字段
└─ fieldId	string	false	自定义字段ID
└─ fieldType	string	false	自定义字段类型 1 文本输入(默认) 2 单选 3 复选 4 数值
└─ fieldValue	Array	false	自定义字段值
authParams	Array	true	鉴权参数集合。对应工作台中的校验参数列表，用于客户侧校验的字段
└─ chineseName	string	true	参数中文名
└─ englishName	string	true	参数英文名
└─ paramType	string	true	参数类型: 文本-text,数值-number,多选-select,单选-checkbox,区间-area （文本：可输入string类型，支持字母+数字+下划线+中文数值：支持双精度小数，整数；支持大于、大于等于、小于等于、小于、区间（闭区间）单选、复选：取值选项标识参数值去string类型，单选仅满足其中之一；复选可以满足所有选项，也可满足其中之一）
└─ values	Object	false	参数值
└─ option	Array	false	多选值
└─ key	string	false	复选框key
└─ value	string	false	复选框value
└─ operator	string	false	操作符(EQ（相等）、GT（大于）、GTEQ（大于等于）、LT（小于）、LTEQ（小于等于）、NEQ（不等）、IN（在枚举范围内）、ALL（全部）、BETWEEN（范围比较） )

接口响应参数说明：

Field	Type	Description	Required
code	string	响应状态码。 200 ：成功。非200都是失败	true
msg	string	响应状态描述	true
data	object	数据。"true"	true
errorCode	string	错误状态码。如果code返回非200，建议接口提供方必填	false

请求参数示例：

{
    "interfaceName": "接口通过",
    "checkType":true,
    "externalConditionUrl":"",
    "externalInformUrl":"",
    "externalConfigId": "7697ac58-0e30-4111-a169-9c96023aacf8",
    "externalConfigOperator": "ALL",
    "externalConfigValues": [
        [
            "shenfen"
        ]
    ],
    "userParam": {
        "audid": "720332229959618560",
        "openid": "wx35c610c7c049ce8287-8",
        "appId":"xxxxxxx",
        "componentId":"xxxxxxx",
        "flowId":"xxxxxxx",
        "appInstanceId": "自建应用的id",
        "identityId": "12345678",
        "identityType": "customerNo;",
        "phone": "18777777777",
        "realName": "张三",
        "address": "广东省深圳市南山区",
        "device": "ios/Android",
        "markFlag": "1",
        "payFeature": "厉害",
        "sex": "1",
        "customFields": [
            {
                "fieldId": "132",
                "fieldType": "text",
                "fieldValue": "434334199111113445",
                "fieldNumValue": "自定义数值"
            },
            {
                "fieldId": "133",
                "fieldType": "text",
                "fieldValue": "231231321222221113",
                "fieldNumValue": "自定义数值"
            }
        ]
    },
    "authParams": [
        {
            "chineseName": "开始日期",
            "englishName": "start_date",
            "paramType": "text",
            "values": "2021-07-01",
            "operator": null,
            "option": [],
        },
        {
            "chineseName": "结束日期",
            "englishName": "end_date",
            "paramType": "text",
            "values": "2021-07-31",
            "operator": null,
            "option": [],
        },
        {
            "chineseName": "首次办理",
            "englishName": "first_deal",
            "paramType": "select",
            "values": "1",
            "operator": null,
            "option": [],
        },
		{
			"chineseName": "111",
			"englishName": "aa",
			"option": [],
			"paramType": "number",
			"values": "222",
			"operator": "EQ"
		},
		{
			"chineseName": "版本",
			"englishName": "bb",
			"option": [
				{
					"key": "我",
					"value": "哈哈"
				},
				{
					"key": "你",
					"value": "哦哦发"
				}
			],
			"paramType": "checkbox",
			"values": "我"
		},
		{
			"chineseName": "此次",
			"englishName": "cc",
			"option": [],
			"paramType": "area",
			"values": [
				20,
				202
			]
		},
		{
			"chineseName": "外部接口参数",
			"englishName": "externalInterface",
			"paramType": "cascader",
			"option": [
				{
					"label": "小程序分组",
					"value": "mini_app_group",
					"type": null,
					"children": [
						{
							"label": "小程序新客",
							"value": "500500",
							"type": null,
							"children": []
						},
						{
							"label": "单位人员",
							"value": "7000661",
							"type": null,
							"children": []
						}
					]
				}
			],
			"values": [
				[
					"mini_app_group"
				]
			],
			"operator": "IN"
		}
        
    ]
}

返回结果示例：

{
    "code":"200",
    "msg":"鉴权成功",
    "data": "true",
    "errorCode" : ""
}

页面树结构