版本比较

标识

  • 该行被添加。
  • 该行被删除。
  • 格式已经改变。

...

外部接口请求方法请求参数返回结构请求示例
获取鉴权条件GET-


代码块
languagejs
themeMidnight
linenumberstrue
{
	"code": "200",
	"msg": "ok",
	"data": [
		{
			"label": "范围",
			"type": "area",
			"value": "",
			"children": [
				{
					"value": "80"
				},
				{
					"value": "100"
				}
			]
		},
{
			"label": "时间范围",
			"type": "dateTimeRange",
			"value": "",
			"children": [
				{
					"value": "YYYY-MM-DD HH:mm"
				},
				{
					"value": "YYYY-MM-DD HH:mm"
				}
			]
		},
		{
			"label": "性别",
			"type": "checkbox",
			"value": "",
			"children": [
				{
					"label": "男",
					"value": "1"
				},
				{
					"label": "女",
					"value": "2"
				}
			]
		},
		{
			"label": "部门",
			"value": "",
			"type": "select",
			"children": [
				{
					"label": "A部门",
					"value": "a"
				},
				{
					"label": "B部门",
					"value": "b"
				},
				{
					"label": "C部门",
					"value": "c"
				}
			]
		},
		{
			"label": "年龄",
			"type": "number",
			"value": "18",
			"children": []
		},
		{
			"label": "分类",
			"type": "cascader",
			"value": "",
			"children": [
				{
					"label": "项目分组",
					"value": "project_group",
					"children": [
						{
							"label": "新客户",
							"value": "1"
						},
						{
							"label": "未成交老客户",
							"value": "2"
						}
					]
				},
				{
					"label": "经纪人分组",
					"value": "broker_group",
					"children": [
						{
							"label": "自由合伙人",
							"value": "9004"
						},
						{
							"label": "代理公司",
							"value": "9003"
						}
					]
				}
			]
		}
	]
}

参数说明

label:标签名称

value:标签值

type:文本 text,数值 number,多选 select,单选 checkbox,区间 area ,级联 cascader

children:子集(只有在级联、多选、单选、区间类型时才不为空)

https://editor.test.rabbitpre.com/api/editor/proxy/thirddata/api/xxx/cms/getAuthConditions


保存通知接口POST


字段名称字段类型是否必传字段说明
userIdstringtrue当前用户id。透传到客户侧的参数
componentIdstringfalse
当前作品下玩法组件ID。透传到客户侧的参数
appIdstringfalse兔展作品ID。透传到客户侧的参数,该值是否一定有值和作品(玩法)的保存顺序有关
authScopenumbertrue

默认值 0。

0:玩法资格配置,

1:作品访问限制资格配置,

2:流程策略资格配置

externalConfigIdstringfalse外部配置id(传空代表新增配置,不为空代表修改配置)。也即该接口响应返回的configId字段值
settingData
Array<Object>false
└─ labelstringtrue名称
└─ namestringtrue标识
└─ valueObjecttrue值。不同的type值对应不同数据格式的value,参考示例。type为text、number的value值是string
└─ typestringfalse文本 text,数值 number,多选 select,单选 checkbox,区间 area ,级联 cascader dateTimeRange
└─ operatorstringfalse

ALL : 全部,IN : 其中之一,
EQ : 等于,GT : 大于,GTEQ : 大于等于,LT : 小于,LTEQ : 小于等于,NEQ :不等于

type为cascader、select、number时为空
sceneTypestringfalse玩法类型:

Award-领奖,Lottery-抽奖,Help-助力,Team-组队,Reserve-预约,Signin-签到,Question-问卷,Answer-答题,Vote-投票,Game-游戏,Task-任务,Points-积分,Seckill-秒杀,GroupBuying-拼团,Tzappid-作品级



代码块
languagejs
themeMidnight
linenumberstrue
{
	"code:" 200,
	"data": {
		// 外部接口返回的配置id
		"configId": "aaa-bbb-ccc"
	}
}



https://editor.test.rabbitpre.com/api/editor/proxy/thirddata/api/xxx/cms/saveNotice

 

入参:

代码块
languagejs
themeMidnight
{
	"settingData": [{
			"label": "职业文本",
			"type": "text",
			"name": "professiontext",
			"value": "文本的值"
		},
		{
			"label": "用户身份数值",
			"type": "number",
			"name": "userFlagNumber",
			"operator": "EQ",
			"value": "9527"
		},
		{
			"label": "性别",
			"type": "select",
			"name": "gender",
			"operator": "IN",
			"value": [
				"1"
			]
		},
		{
			"label": "是否新客户",
			"type": "checkbox",
			"name": "isCustomer",
			"value": "1"
		},
		{
			"label": "人生阶段",
			"type": "select",
			"name": "lifeStage",
			"operator": "IN",
			"value": [
				"1",
				"2",
				"3",
				"4"
			]
		},
		{},
		{
			"label": "城市",
			"type": "cascader",
			"name": "city",
			"operator": "IN",
			"value": [{
					"label": "北京市",
					"value": "北京市",
					"type": null,
					"children": [{
						"label": "北京市",
						"value": "北京市",
						"type": null,
						"children": null
					}]
				},
				{
					"label": "天津市",
					"value": "天津市",
					"type": null,
					"children": [{
						"label": "天津市",
						"value": "天津市",
						"type": null,
						"children": null
					}]
				}
			]
		}, {
			"label": "城市",
			"type": "cascader",
			"name": "city",
			"operator": "IN",
			"value": ["北京市", "天津"]
		}
	]
}],
"externalConfigId": "",
"userId": "2a40a6c6-7379-4961-9088-cb9a071f3a55",
"componentId": "31bc2f36-c5de-4c34-adf6-c967a92561b8",
"sceneType": "Tzappid",
"appId": "31bc2f36-c5de-4c34-adf6-c967a92561b8",
"authScope": 1
}


 

 

 






鉴权接口协议:

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

...

字段名称

字段类型

是否必传

字段说明

interfaceName

stringtrue接口鉴权名称

checkType

stringfalse

校验类型: 

false:自定义设置 

true:外部接口回调

externalConditionUrl

stringfalse外部接口回调-获取鉴权条件URL

externalInformUrl

stringfalse外部接口回调-保存通知接口

externalConfigId

stringfalse外部接口配置的ID
userParamObjecttrue用户参数。对应自建应用中的系统参数中的固定参数
└─ audidstringtrue客户档案id
└─ openidstringfalseopenid
└─ appIdstringtrue作品id
└─ componentIdstringfalse组件id
└─ flowIdstringfalse流程策略id
└─ appInstanceIdstringfalse自建应用的id
└─ identityIdstringfalse自建应用的识别的身份id
└─ identityTypestringfalse自建应用的身份类型
└─ realName stringfalse真实姓名
└─ phone   stringfalse手机号码
└─ addressstringfalse地址信息
└─ devicestringfalse手机型号 ios/Android
└─ markFlagintegerfalse

是否星标 1 0

└─ payFeaturestringfalse消费特点
└─ sexintegerfalse性别 1男 2女
└─ identitysArrayfalse用户多身份信息
     └─ identityId stringfalse自建应用的识别的身份id。platform=EXTERNAL(自建应用)
     └─ identityType stringfalse自建应用的身份类型。platform=EXTERNAL(自建应用)
     └─ fromTostringfalse标识来源
     └─ platformstringfalse标识来源平台。平台标识,gzh(微信公众号)、contentminiapp(微信小程序)、EXTERNAL(自建应用)
     └─ openidstringfalseopenid (当 fromTo 为 gzh(微信公众号) 时,openid有值)
     └─ unionidstringfalseunionid (当 fromTo 为 gzh(微信公众号) 时,unionid有值)

     └─ jcappid

Long

true系统集成Id
     └─ appid stringfalse公众号appid

└─ customFields

Arrayfalse

自定义字段可能会存在多个。对应工作台中的用户-字段管理中的字段

此参数已删除

     └─ fieldId

stringfalse

自定义字段ID

     └─ fieldType

stringfalse

自定义字段类型 1 文本输入(默认) 2 单选 3 复选 4 数值

     └─ fieldValue

Arrayfalse

自定义字段值

authParams

Arraytrue鉴权参数集合。对应工作台中的校验参数列表,用于客户侧校验的字段
└─ chineseNamestringtrue参数中文名
└─ englishNamestringtrue参数英文名

└─ paramType

stringtrue

参数类型:

文本-text,数值-number,多选-select,单选-checkbox,区间-area

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

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

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

└─ valuesObjectfalse

参数值

└─ option

Arrayfalse多选值
     └─ keystringfalse复选框key
     └─ valuestringfalse复选框value
└─ operatorstringfalse操作符(EQ(相等)、GT(大于)、GTEQ(大于等于)、LT(小于)、LTEQ(小于等于)、NEQ(不等)、IN(在枚举范围内)、ALL(全部)、BETWEEN(范围比较) )

...