配置说明

营销SaaS使用纷享销客自建企业应用作为对接方式。

参考创建开放平台应用 | 纷享开放平台-开发文档 中描述，创建企业应用，并在营销SaaS后台将其填入。

如果需要设置IP白名单，目前使用 47.99.49.216 ，并将其填入纷享销客开放平台设置项中。

在营销SaaS配置后台，需要下面三组数据，在纷享销客后台获取后进行填入。

营销SaaS系统利用 获取应用级授权 | 纷享开放平台-开发文档 中描述的 获取应用级授权 方式来获取token并调用后续接口。

开关默认为关闭状态。

在开启开关后，营销SaaS将在有自动获取到的客户（表单、注册会员等）进来时，将这个客户信息通过纷享销客接口推送过去。

营销对纷享销客的推送接口做了比较灵活的可配置设置。

根据纷享销客开发文档，线索、商机、客户等几种类型的推送接口基本一致，主要区别在于传递的dataObjectApiName不同。因此通过对API路径和指定参数的配置，可以实现营销SaaS客户往纷享销客不同的对象类型（商机、商机2.0、客户、线索等）进行推送（目前只支持配置成其中一种）。

下面是可供配置的配置项，通常一次配置后就可以使用了。目前采用JSON形式的配置文本进行设置，后续会更新为更加图形化的表格形式。

1.      API路径设置: 根据文档，线索、商机、客户等都是  https://open.fxiaoke.com/cgi/crm/v2/data/create 这个路径。

2.      基础数据字段设置： 这里设置每次接口调用的固定键值对。

3.      字段映射设置：将营销SaaS的客户字段映射为用户纷享销客后台设置的字段名称与值。这里包括日期格式的转换、选项格式的转换等

下面说明以线索对象为例： 创建线索对象 | 纷享开放平台-开发文档 。其他类型可以根据文档说明进行配置（通常只需要更改dataObjectApiName）。

根据文档，有以下几个必填字段：

这个为必填项目，按照说明通过接口推送过去后，会显示操作人为该人名字。

应该可以通过纷享销客后台，获取其中一个操作人的UserId，并设置到这里。

如果后台无法直接获得，可提供对应手机号通过接口进行获取。

 2.      data.object_data.dataObjectApiName (对应推送的对象类型)

以线索类型为例，这里的值 LeadsObj。

其他类型可以参照开发文档，比如商机联系人(NewOpportunityContactsObj)，商机2.0(NewOpportunityObj)，客户(AccountObj) 等。

如果是/cgi/crm/v2/data/create以外的API路径，也可以通过此处配置固定字段来进行调用。

目前通过JSON数组的方式对每个字段进行配置，格式为 [{key: 键, value: 值}, ...]。

配置示例

[
	{
		"key": "currentOpenUserId",
		"value": "xxx123456"
	},
	{
		"key": "data.object_data.dataObjectApiName",
		"value": "LeadsObj"
	}
]

2.4.      字段映射配置

因为营销SaaS客户数据格式与纷享销客平台配置不一致，因此需要对字段映射做配置。作用是将营销SaaS的客户数据格式，在推送前转换为纷享销客上的的目标格式（字段名称与值）。

例: 纷享销客的字段Api Name

目前这里仍然使用JSON文本方式进行配置。其中key为API数据包中的路径，嵌套路径使用点隔开，如 data.object_data.name。

目前营销SaaS客户可供推送的字段有：

大部分字段为文本格式，可以直接传递。

两种情况比较特殊：

1.      选项格式（clueType字段）

客户类型为整型选项值，可以根据实际需要转换为文本或者其他选项值（在纷享销客对象中的定义值）。

下面是目前的几种类型：

在配置中可以使用一个map字段来进行映射，可以参考下方示例配置。

2.      时间格式（createdAt、updatedAt字段）

如果需要以 2023-06-05 11:53:43 这样的格式传递，可以通过格式化选项将其格式化为对应的格式。

可以根据实际情况对这些数据进行转换，并映射到纷享销客的对象字段中。下面是一个示例

[
	{
		"key": "data.object_data.name",
		"value": {
			"field": "remarkName"
		}
	},
	{
		"key": "data.object_data.clue_id",
		"value": {
			"field": "id"
		}
	},
	{
		"key": "data.object_data.create_date",
		"value": {
			"field": "createdAt",
			"format": "yyyy-MM-dd"
		}
	},
	{
		"key": "data.object_data.remark",
		"value": {
			"field": "remark"
		}
	},
	{
		"key": "data.object_data.phone",
		"value": {
			"field": "phone"
		}
	},
	{
		"key": "data.object_data.email",
		"value": {
			"field": "email"
		}
	},
	{
		"key": "data.object_data.wechat_name",
		"value": {
			"field": "wechat"
		}
	},
	{
		"key": "data.object_data.contact",
		"value": {
			"field": "otherPhone"
		}
	},
	{
		"key": "data.object_data.source_type",
		"value": {
			"field": "clueType",
			"map": {
				"3": "提交表单",
				"6": "名片授权手机号",
				"7": "名片访客",
				"8": "网站注册会员",
				"9": "手动添加",
				"11": "其他"
			}
		}
	},
	{
		"key": "data.object_data.source",
		"value": {
			"field": "platform"
		}
	}
]

配置说明

 key: 对应的API Payload的键路径

 value:

 field：LTD线索详情的路径，取值

 map: LTD线索详情获取到值以后，可以做进一步映射

 prefix: 在有需要的情况下，将取到并map后的值，前面加一个前缀，比如「线索ID: 123456」

 format: createdAt等时间戳形式的字符串，可以通过format来进行格式化，目前暂支持PHP的格式，比如 "Y-m-d H:i:s"