...
鉴权接口完整URL：自建应用方自己的 domain+URI
例如： https://aa.bb.com/api/xx/checkDataAuthcheckUserAuth
接口协议：HTTPS
HTTP请求方式：POST
consumes ：application/json
...
字段名称 | 字段类型 | 是否必传 | 字段说明 |
|---|---|---|---|
interfaceName | string | true | 接口鉴权名称 |
checkType | string | false | 校验类型: false:自定义设置 true:外部接口回调 |
externalConditionUrl | string | false | 外部接口回调-获取鉴权条件URL |
externalInformUrl | String | false | 外部接口回调-保存通知接口 |
externalConfigId | string | false | 外部接口配置的ID |
| 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（范围比较） ) |
接口响应参数说明：
Field |
|---|
Type |
|---|
Description |
|---|
Required | |
|---|---|
code | string |
响应状态码。 200 ： 成功。非200都是失败 | true | ||
msg | string | 响应状态描述 | true |
data | object | 数据 | - |
| errorCode | string | 错误状态码 | 如果code返回非200，建议接口提供方必填 |
请求参数示例：
| 代码块 | ||||
|---|---|---|---|---|
| ||||
{
"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",
"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",
"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
]
}
]
} |
响应结果：
...
Field
...
Type
...
Description
...
Required
...
code
...
string
...
状态码。
200 ： 成功。非200都是失败
...
必填
...
errorCode
...
string
...
错误状态码
...
如果code返回非200，建议接口提供方必填
...
msg
...
string
...
状态描述
...
建议必填
...
data
...
object
...
数据
...
返回结果示例：
| 代码块 | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"code":"200",
"msg":"鉴权成功",
"data": "true",
"errorCode" : ""
} |
...