概述:

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

我需要准备什么?

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

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



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


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

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



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

鉴权接口协议:

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

例如: https://aa.bb.com/api/xx/checkDataAuth

接口协议:HTTPS

HTTP请求方式:POST

consumes :application/json

produces :application/json

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

接口参数说明表:


字段名称

字段类型

是否必传

字段说明

appIdStringtrue作品id
componetIdStringfalse插件id
flowIdStringfalse策略id

interfaceName

stringfalse接口鉴权名称
userParamObjecttrue用户参数
audidstringtrue用户档案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

listfalse

自定义字段值

authParams

listtrue鉴权参数集合
chineseNamestringtrue参数中文名
englishNamestringtrue参数英文名

paramType

stringtrue

参数类型

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

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

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

valueslistfalse

参数值

option

stringfalse多选值
operatorstringfalse操作符(EQ(相等)、GT(大于)、GTEQ(大于等于)、LT(小于)、LTEQ(小于等于)、NEQ(不等)、IN(在枚举范围内)、ALL(全部)、BETWEEN(范围比较) )


接口响应参数说明:

字段名

类型

必选

说明

codestringtrue

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


msg

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

请求参数示例:

{ 
  "appId": "2201bb15-3138-4b14-bea5-225142612922",
  "componetId": "416f615e-dae2-11ea-9259-00155dabc525",	
  "flowId": "strategy_1624444157076_2", 
  "interfaceName": "接口通过",
  "userParam": {
    "audid": "720332229959618560",
    "openid":"wx35c610c7c049ce8287-8",
    "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"
      },
	  {
        "fieldId": "133", /*卡号*/
        "fieldType": "text",
        "fieldValue": "231231321222221113"
      }
    ]
  },
  "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", /*1社保卡,2/工会卡卡*/
	  "operator": null,
      "option": ""
    }
  ]
}

返回结构示例:

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


  • 无标签