背景说明:
兔展支持限制当前用户是否有参与某个玩法或者进入作品的资格,由第三方系统进行控制。
功能说明:
准备工作
1、申请自建应用,点击新建应用;
2、填写应用名称,选择【编辑器】——【自定义接口鉴权】,点击申请开通,等待审核;
3、审核通过后,显示如下,点击【添加接口】,选择【编辑】,记得点击保存哟;
4、选择鉴权配置界面;
5、点击确认、保存即可,记得自建应用也要点保存哟;
编辑器配置:
1、选择某个玩法;
2、在参与资格中,选择接口鉴权;
3、选择自建应用;
4、选择鉴权方式;
5、可以正常使用活动参与资格鉴权的功能。
鉴权接口协议:
鉴权接口完整URL:自建应用方自己的 domain+URI
(兔展方 ---调用---> 第三方)
接口协议:HTTPS
HTTP请求方式:POST
consumes :application/json
produces :application/json
接口响应时间:3秒以内,最好能达到百毫秒级,满足高并发场景。兔展方调用鉴权接口最多等待3秒,超过3秒没有响应,自动放弃请求,判定为鉴权失败。
接口参数说明表:
字段名称 | 字段类型 | 是否必传 | 字段说明 |
---|---|---|---|
interfaceName | string | true | 接口鉴权名称 |
checkType | string | false | 校验类型: false:自定义设置 true:外部接口回调 |
externalConditionUrl | string | false | 外部接口回调-获取鉴权条件URL |
externalInformUrl | String | false | 外部接口回调-保存通知接口 |
externalConfigId | string | false | 外部接口配置的ID |
externalConfigOperator | string | false | 外部条件操作符 |
externalConfigValues | list<list<string>> | false | 外部条件值 |
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 | int | false | 性别 1男 2女 |
└─ customFields | list | false | 自定义字段可能会存在多个 |
└─└─ fieldId | string | false | 自定义字段ID |
└─└─ fieldType | string | false | 自定义字段类型 1 文本输入(默认) 2 单选 3 复选 4 数值 |
└─└─ fieldValue | list<string> | false | 自定义字段值 |
authParams | list | true | 鉴权参数集合 |
└─ chineseName | string | true | 参数中文名 |
└─ englishName | string | true | 参数英文名 |
└─ paramType | string | true | 参数类型: 文本-text,数值-number,多选-select,单选-checkbox,区间-area (文本:可输入string类型,支持字母+数字+下划线+中文 数值:支持双精度小数,整数;支持大于、大于等于、小于等于、小于、区间(闭区间) 单选、复选: 取值 选项标识参数值去string类型,单选仅满足其中之一;复选可以满足所有选项,也可满足其中之一 ) |
└─ values | Object | false | 参数值 |
└─ option | List<string> | false | 多选值 |
└─ └─ key | string | false | 复选框key |
└─ └─ value | string | false | 复选框value |
└─ operator | string | false | 操作符(EQ(相等)、GT(大于)、GTEQ(大于等于)、LT(小于)、LTEQ(小于等于)、NEQ(不等)、IN(在枚举范围内)、ALL(全部)、BETWEEN(范围比较) ) |
接口响应参数说明:
字段名 | 类型 | 必选 | 说明 |
---|---|---|---|
code | string | true | 结果返回码,200为正常,其余都为错误 |
msg | string | true | 结果信息。被调用方响应的信息 |