版本比较

标识

  • 该行被添加。
  • 该行被删除。
  • 格式已经改变。

...

  1. 本授权功能需接入方企业先在营销云开通 “数据集成” 模块,并获得 “自建应用” 的使用权限。

  2. 自建应用内申请开通 编辑器 → 自定义接口鉴权,后续联系管理员审核通过。应用配置界面如下:



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

    注意:此处如果需要自定义外部的校验参数,需勾选”外部接口回调“选项进行配置,具体配置如下
    Image AddedImage Removed



  3. 完成配置后,点击“保存”即可。

  4. 在编辑器中,可在作品预览页面开启作品访问限制鉴权,或在活动玩法配置中对应限制选项中进行配置,配置界面如下:



  5. 此配置案例下,在用户访问作品时,会调用主办方配置的鉴权接口,发送在数据集成自定义接口鉴权中配置好的字段,通过接口返回结果来判断用户是否具有作品访问资格。

外部接口鉴权api参数说明

外部接口请求方法请求参数返回结构
获取鉴权条件GET-


代码块
languagejs
linenumberstrue
collapsetrue
{
	"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:子集(只有在级联、多选、单选、区间类型时才不为空)

保存通知接口POST



{

// 外部参数运算符,选项有“ALL”和“IN”,分别对应满足全部与其中之一 "externalConfigOperator": "ALL", // 外部参数values,值为List<List<string>>的解构,为所选参数的value集合

"externalConfigValues": [["shenzhen"],["guangzhou"]],

}


代码块
languagejs
{
	"code:" 200,
	"data": {
		// 外部接口返回的配置id
		"configId": "xxxxx"
	}
}


鉴权接口协议:

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

...

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


接口参数说明表:

字段名称

字段类型

是否必传

字段说明

interfaceName

stringtrue接口鉴权名称

checkType

stringfalse

校验类型: 

false:自定义设置 

true:外部接口回调

externalConditionUrl

stringfalse外部接口回调-获取鉴权条件URL

externalInformUrl

Stringfalse外部接口回调-保存通知接口

externalConfigId

stringfalse外部接口配置的ID

externalConfigOperator

stringfalse外部条件操作符

externalConfigValues

list<list<string>>false外部条件值
userParamObjecttrue用户参数。对应自建应用中的系统参数中的固定参数
└─ audidstringtrue客户档案id
└─ openidstringfalseopenid
└─ appIdstringtrue作品id
└─ componentIdstringfalse组件id
└─ flowIdstringfalse流程策略id
└─ appInstanceIdstringfalse自建应用的id
└─ identityIdstringfalse自建应用的识别的身份id
└─ identityTypestringfalse自建应用的身份类型
└─ realName stringfalse真实姓名
└─ phone   stringfalse手机号码
└─ addressstringfalse地址信息
└─ devicestringfalse手机型号 ios/Android
└─ markFlagintegerfalse

是否星标 1 0

└─ payFeatureStringfalse消费特点
└─ sexintfalse性别 1男 2女

└─ customFields

listfalse自定义字段可能会存在多个。对应工作台中的用户-字段管理中的字段

└─ fieldId

stringfalse

自定义字段ID

└─ fieldType

stringfalse

自定义字段类型 1 文本输入(默认) 2 单选 3 复选 4 数值

└─ fieldValue

list<string>false

自定义字段值

authParams

listtrue鉴权参数集合。对应工作台中的校验参数列表,用于客户侧校验的字段
└─ chineseNamestringtrue参数中文名
└─ englishNamestringtrue参数英文名

└─ paramType

stringtrue

参数类型:

文本-text,数值-number,多选-select,单选-checkbox,区间-area

(文本:可输入string类型,支持字母+数字+下划线+中文

数值:支持双精度小数,整数;支持大于、大于等于、小于等于、小于、区间(闭区间) 

单选、复选: 取值 选项标识参数值去string类型,单选仅满足其中之一;复选可以满足所有选项,也可满足其中之一 )

└─ valuesObjectfalse

参数值

└─ option

List<string>false多选值
└─ ─ keystringfalse复选框key
└─ ─ valuestringfalse复选框value
└─ operatorstringfalse操作符(EQ(相等)、GT(大于)、GTEQ(大于等于)、LT(小于)、LTEQ(小于等于)、NEQ(不等)、IN(在枚举范围内)、ALL(全部)、BETWEEN(范围比较) )

接口响应参数说明:

字段名

类型

必选

说明

codestringtrue

结果返回码,200为正常,其余都为错误


msg

stringtrue结果信息。被调用方响应的信息

...