...
接口响应时间:3秒以内,最好能达到百毫秒级,满足高并发场景。活动H5方调用鉴权接口最多等待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类型,单选仅满足其中之一;复选可以满足所有选项,也可满足其中之一
单选、复选: 取值 选项标识参数值去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 | 结果信息。被调用方响应的信息 |
...
代码块 | ||||
---|---|---|---|---|
| ||||
{ "interfaceName": "接口通过", "checkType":true, "appIdexternalConditionUrl":"", "2201bb15-3138-4b14-bea5-225142612922 "externalInformUrl":"", "componetIdexternalConfigId": "416f615e7697ac58-dae20e30-11ea4111-9259a169-00155dabc5259c96023aacf8", "flowIdexternalConfigOperator": "strategy_1624444157076_2ALL", "interfaceNameexternalConfigValues": "接口通过", [ [ "shenfen" ] ], "userParam": { "audid": "720332229959618560", "openid": "wx35c610c7c049ce8287-8", "appId":"xxxxxxx", "componentId":"xxxxxxx", "flowId":"xxxxxxx", "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", "operator": null, "option": "" }, { "chineseName": "111", /*1社保卡,2/工会卡卡*/ "operator": null, "option": "" } "englishName": "aa", "option": [], "paramType": "number", "values": "222", "operator": "EQ" }, { "chineseName": "版本", "englishName": "bb", "option": [ { "key": "我", "value": "哈哈" }, { "key": "你", "value": "哦哦发" } ], "paramType": "checkbox", "values": "我" }, { "chineseName": "此次", "englishName": "cc", "option": [], "paramType": "area", "values": [ 20, 202 ] } ] } |
返回结构示例:
代码块 | ||||
---|---|---|---|---|
| ||||
{ "code":"200", "msg":"鉴权成功" } |
...