...
- 本授权功能需接入方企业先在营销云开通 “数据集成” 模块，并获得 “自建应用” 的使用权限。
- 自建应用内申请开通 编辑器 → 自定义接口鉴权，后续联系管理员审核通过。应用配置界面如下：
添加后，点击“编辑”进入对应设置页
注意：此处如果需要自定义外部的校验参数，需勾选”外部接口回调“选项进行配置，具体配置如下
- 完成配置后，点击“保存”即可。
- 在编辑器中，可在作品预览页面开启作品访问限制鉴权，或在活动玩法配置中对应限制选项中进行配置，配置界面如下：
- 此配置案例下，在用户访问作品时，会调用主办方配置的鉴权接口，发送在数据集成自定义接口鉴权中配置好的字段，通过接口返回结果来判断用户是否具有作品访问资格。
外部接口鉴权api参数说明
| 外部接口 | 请求方法 | 请求参数 | 返回结构 | 请求示例 | |||
|---|---|---|---|---|---|---|---|
| 获取鉴权条件 | GET | - |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
参数说明
label：标签名称
value：标签值
type：文本 text,数值 number,多选 select,单选 checkbox,区间 area ,级联 cascader
children：子集（只有在级联、多选、单选、区间类型时才不为空）
https://editor.test.rabbitpre.com/api/editor/proxy/thirddata/api/xxx/cms/getAuthConditions
参数说明 label：标签名称 value：标签值 type：文本 text,数值 number,多选 select,单选 checkbox,区间 area ,级联 cascader children：子集（只有在级联、多选、单选、区间类型时才不为空） | https://editor.test.rabbitpre.com/api/editor/proxy/thirddata/api/xxx/cms/getAuthConditions | |||||||||||
| 保存通知接口 | POST |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
入参：
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| ||||
鉴权接口协议：
鉴权接口完整URL：自建应用方自己的 domain+URI
例如： https://aa.bb.com/api/xx/checkDataAuthcheckUserAuth
接口协议：HTTPS
HTTP请求方式：POST
consumes ：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 |
externalConfigOperator
externalConfigValues
| 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
| 自建应用的识别的身份id。platform=EXTERNAL（自建应用） | ||
| └─ identityType | string | false |
自定义字段类型 1 文本输入(默认) 2 单选 3 复选 4 数值
└─ ─ ─ fieldValue
| 自建应用的身份类型。platform=EXTERNAL（自建应用） | ||
| └─ fromTo | string | false |
自定义字段值
authParams
| 标识来源 | |||
| └─ platform | string | false | 标识来源平台。平台标识，gzh（微信公众号）、contentminiapp（微信小程序）、EXTERNAL（自建应用） |
| └─ openid | string |
| false | openid （当 fromTo 为 gzh（微信公众号） 时，openid有值） |
| └─ unionid | string |
└─ paramType
| false | unionid （当 fromTo 为 gzh（微信公众号） 时，unionid有值） |
└─ jcappid | Long |
| true |
参数类型:
文本-text,数值-number,多选-select,单选-checkbox,区间-area
（文本：可输入string类型，支持字母+数字+下划线+中文
数值：支持双精度小数，整数；支持大于、大于等于、小于等于、小于、区间（闭区间）
单选、复选： 取值 选项标识参数值去string类型，单选仅满足其中之一；复选可以满足所有选项，也可满足其中之一 ）
参数值
└─ option
接口响应参数说明：
...
字段名
...
类型
...
说明
...
结果返回码，200为正常，其余都为错误
| 系统集成Id | |||
| └─ appid | string | false | 公众号appid |
|
| ||
|
| ||
|
| ||
|
| ||
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（范围比较） ) |
externalExtras | Object | false | 外部扩展参数 |
| └─ key1 | String | false | 外部参数key1，根据实际传递的参数 |
| └─ key2 | String | false | 外部参数key2，根据实际传递的参数 |
接口响应参数说明：
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", |
...
msg
...
请求参数示例：
| 代码块 | ||||
|---|---|---|---|---|
| ||||
{ "interfaceName": "接口通过", "checkType":true, "externalConditionUrl":"", "externalInformUrl":"", "externalConfigId": "7697ac58-0e30-4111-a169-9c96023aacf8", "externalConfigOperator": "ALL", "externalConfigValues": [ [ "identityType": "shenfencustomerNo;", ]"phone": "18777777777", ], "userParamrealName": {"张三", "audidaddress": "720332229959618560广东省深圳市南山区", "openiddevice": "wx35c610c7c049ce8287-8ios/Android", "appIdmarkFlag": "xxxxxxx1", "componentIdpayFeature": "xxxxxxx厉害", "flowIdsex": "xxxxxxx1", }, "appInstanceIdauthParams": "自建应用的id", [ { "identityId": "12345678", "identityTypechineseName": "customerNo;开始日期", "phoneenglishName": "18777777777start_date", "realNameparamType": "张三text", "addressvalues": "广东省深圳市南山区2021-07-01", "deviceoperator": "ios/Android"null, "markFlagoption": "1"[], "payFeature": "厉害"}, "sex": "1", { "customFieldschineseName": ["结束日期", {"englishName": "end_date", "fieldIdparamType": "132text", "fieldTypevalues": "text2021-07-31", "fieldValueoperator": "434334199111113445"null, "option": [], "fieldNumValue": "自定义数值" }, },{ { "chineseName": "首次办理", "fieldIdenglishName": "133first_deal", "fieldTypeparamType": "textselect", "fieldValuevalues": "2312313212222211131", "fieldNumValueoperator": "自定义数值"null, } "option": [], ] }, "authParams}, { "chineseName": "111", "englishName": "aa", "option": [], "paramType": { "chineseName"number", "values": "222", "operator": "开始日期EQ", "englishName }, { "chineseName": "start_date版本", "paramType "englishName": "textbb", "values "option": [ { "key": "2021-07-01我", "operator": null, "option": [], }, { "chineseName": "结束日期", "englishName": "end_date", "value": "哈哈" }, { "key": "你", "value": "哦哦发" } ], "paramType": "textcheckbox", "values": "2021-07-31", "operator": null, 我" }, { "chineseName": "此次", "englishName": "cc", "option": [], }, { "chineseName "paramType": "首次办理area", "englishName": "first_deal", "paramType": "select", "values": "1", "operator": null, "option": [], "values": [ 20, 202 ] }, { "chineseName": "此次", "englishName": "cc", "option": [], "paramType": "dateTimeRange", "values": [ 20, 202 ] }, { "chineseName": "111外部接口参数", "englishName": "aa","externalInterface", "paramType": "cascader", "option": [ "option { "label": []"小程序分组", "paramTypevalue": "numbermini_app_group", "valuestype": "222"null, "operatorchildren": "EQ"[ }, { "chineseNamelabel": "版本小程序新客", "englishNamevalue": "bb500500", "option": [ { "key"type": "我"null, "valuechildren": "哈哈" [] }, { "keylabel": "你单位人员", "value": "哦哦发7000661", } ], "paramTypetype": "checkbox"null, "valueschildren": "我"[] }, { } ] } "chineseName": "此次"], "englishNamevalues": "cc",[ "option": [], [ "paramType": "area", "values": [ "mini_app_group" ] 20], 202"operator": "IN" ] }} ], "externalExtras":{ "key1":"value1", "key2":"value2" ]} } |
...
返回结果示例：
| 代码块 | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"code":"200",
"msg":"鉴权成功",
"data": "true",
"errorCode" : ""
} |