接口说明:活动参与资格接口鉴权
访问URI: 自建应用方自己配置的URI
例:api/xx/checkDataAuth
完整URL:自建应用方自己的 domain+URI
例: https://aa.bb.com/api/xx/checkDataAuth
接口协议:HTTPS
HTTP请求方式:POST
consumes :application/json
produces :application/json
接口响应时间:3s 以内,最好能达到百毫秒级
请求参数
字段名称 | 字段类型 | 是否必传 | 字段说明 |
---|---|---|---|
interfaceName | string | false | 接口鉴权名称 |
userParam | Object | true | 用户参数 |
audid | string | true | 客户档案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 | false | 自定义字段值 |
authParams | list | true | 鉴权参数集合 |
chineseName | string | true | 参数中文名 |
englishName | string | true | 参数英文名 |
paramType | string | true | 参数类型 文本:可输入string类型,支持字母+数字+下划线+中文 数值:支持双精度小数,整数;支持大于、大于等于、小于等于、小于、区间(闭区间) 单选、复选: 取值 选项标识参数值去string类型,单选仅满足其中之一;复选可以满足所有选项,也可满足其中之一 |
values | list | false | 参数值 |
option | string | false | 多选值 |
operator | string | 操作符(EQ(相等)、GT(大于)、GTEQ(大于等于)、LT(小于)、LTEQ(小于等于)、NEQ(不等)、IN(在枚举范围内)、ALL(全部)、BETWEEN(范围比较) ) |
响应参数
字段名 | 类型 | 必选 | 说明 |
---|---|---|---|
code | string | true | 结果返回码,200为正常,其余都为错误 |
msg | string | true | 结果信息。被调用方响应的信息 |
请求示例
{ "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", "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",/*1社保卡,2/工会卡卡*/ "operator": null, "option": "" } ] }
返回示例
{ "code":"200", "msg":"鉴权成功" }