API开放平台

TIP

# 积分管理

# 客户积分查询接口

接口说明：通过来源于第三方的客户唯一标识，和勤策的客户唯一标识、客户编码查询客户积分

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/bonuspoints/v1/querycusbp/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
	"sourceCode":"kehucode",
	"customerId": "5108521383450986770",
	"customerCode": "STORE2021081201539"
}
说明： 来源于第三方的客户唯一标识，和勤策的客户唯一标识、客户编码不能同时为空

参数说明：

参数 类型 必填 说明
sourceCode VARCHAR(200) 否 来源于第三方的客户唯一标识
customerId VARCHAR(64) 否 勤策的客户唯一标识
customerCode VARCHAR(64) 否 客户编码

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
	{
		"code": "STORE2021081201539",
		"balance": "5021.01",
		"name": "qinqiang_test",
		"id": "5108521383450986770",
		"source_code": "kehucode"
	}
]

参数说明：

参数 类型 说明
code VARCHAR(100) 客户编码
balance VARCHAR(100) 当前可用积分
name VARCHAR(100) 客户名称
id VARCHAR(100) 勤策的客户唯一标识
source_code VARCHAR(200) 来源于第三方的客户唯一标识

# 客户积分新增/扣减接口

接口说明：通过来源于第三方的客户唯一标识，和勤策的客户唯一标识、客户编码对客户积分进行增加或减少,并生成备注

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/bonuspoints/v1/cusbpchange/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "sourceCode":"kehucode",
    "customerId": "5108521383450986770",
    "customerCode": "STORE2021081201539",
    "amount": "3.14",
    "remark": "测试增加数据3.14"
}
说明： 来源于第三方的客户唯一标识，和勤策的客户唯一标识、客户编码不能同时为空

参数说明：

参数 类型 必填 说明
sourceCode VARCHAR(200) 否 来源于第三方的客户唯一标识
customerId VARCHAR(64) 否 勤策的客户唯一标识
customerCode VARCHAR(64) 否 客户编码
amount VARCHAR(64) 是 变动积分，仅支持2位小数，新增积分填写正数，扣减积分填写负数
remark VARCHAR(64) 否 备注

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }"
}

# 客户积分变动日志查询接口

接口说明：通过来源于第三方的客户唯一标识，和勤策的客户唯一标识、客户编码以及日期范围查询客户积分变动日志

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/bonuspoints/v1/querycusbpchange/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "sourceCode":"kehucode",
    "customerId": "5108521383450986770",
    "customerCode": "STORE2021081201539",
    "beginTime": "2019-10-12",
    "endTime": "2024-10-11"
}
说明： 来源于第三方的客户唯一标识，和勤策的客户唯一标识、客户编码不能同时为空

参数说明：

参数 类型 必填 说明
sourceCode VARCHAR(200) 否 来源于第三方的客户唯一标识
customerId VARCHAR(64) 否 勤策的客户唯一标识
customerCode VARCHAR(64) 否 客户编码
beginTime VARCHAR(64) 否 查询开始时间，格式：yyyy-MM-dd
endTime VARCHAR(64) 否 查询结束时间，格式：yyyy-MM-dd

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
	{
		"code": "STORE2021081201539",
		"name": "qinqiang_test",
		"id": "5108521383450986770",
		"source_code": "kehucode",
		"list": [
			{
				"changeTime": "2021-04-10 11:23:59",
				"changeBp": "5000.0",
				"operateType": "手动新增",
				"code": "kehujifentest",
				"name": "客户积分测试"
			},
			{
				"changeTime": "2023-01-17 16:44:45",
				"changeBp": "13.45",
				"operateType": "接口同步增加",
				"code": "kehujifentest",
				"name": "客户积分测试"
			},
			{
				"changeTime": "2023-01-17 16:47:36",
				"changeBp": "-12.45",
				"operateType": "接口同步减少",
				"code": "kehujifentest",
				"name": "客户积分测试"
			},
			{
				"changeTime": "2023-01-17 16:50:00",
				"changeBp": "-12.45",
				"operateType": "接口同步减少",
				"code": "kehujifentest",
				"name": "客户积分测试"
			},
			{
				"changeTime": "2023-01-17 16:53:16",
				"changeBp": "-12.45",
				"operateType": "接口同步减少",
				"code": "kehujifentest",
				"name": "客户积分测试"
			},
			{
				"changeTime": "2023-01-17 20:07:02",
				"changeBp": "31.46",
				"operateType": "接口同步增加",
				"code": "kehujifentest",
				"name": "客户积分测试"
			}
		]
	}
]

参数说明：

参数 类型 说明
code VARCHAR(100) 客户编码
name VARCHAR(100) 客户名称
id VARCHAR(100) 勤策的客户唯一标识
source_code VARCHAR(200) 来源于第三方的客户唯一标识
list.changeTime VARCHAR(200) 变更时间
list.changeBp VARCHAR(200) 变更积分
list.operateType VARCHAR(200) 变更类型
list.code VARCHAR(200) 创建人账号
list.name VARCHAR(200) 创建人姓名

# 员工积分查询接口

接口说明：通过来源于第三方的员工唯一标识，和勤策的员工唯一标识、员工登录账号查询员工积分

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/bonuspoints/v1/queryuserbp/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
	"sourceCode":"testyuangong",
	"userId": "5119344588087994379",
	"userCode": "14252552555"
}
说明：来源于员工登录帐号，和第三方系统的员工唯一标识、勤策的员工唯一标识不能同时为空

参数说明：

参数 类型 必填 说明
sourceCode VARCHAR(200) 否 第三方系统的员工唯一标识
userId VARCHAR(64) 否 勤策的员工唯一标识
userCode VARCHAR(64) 否 员工登录帐号

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
	{
		"code": "14252552555",
		"balance": 191.11,
		"user_id": "5119344588087994379",
		"name": "员工测试",
		"dept_name": "泗阳分公司",
		"source_code": "testyuangong"
	}
]

参数说明：

参数 类型 说明
code VARCHAR(100) 员工登录账号
balance VARCHAR(100) 当前可用积分
user_id VARCHAR(100) 勤策的员工唯一标识
name VARCHAR(100) 员工姓名
dept_name VARCHAR(100) 所属部门
source_code VARCHAR(200) 第三方系统的员工唯一标识

# 员工积分新增/扣减接口

接口说明：通过来源于第三方的员工唯一标识，和勤策的员工唯一标识、员工登录账号对员工积分进行增加或减少,并生成备注

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/bonuspoints/v1/userbpchange/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
	"sourceCode": "testyuangong",
	"userId": "5119344588087994379",
	"userCode": "14252552555",
	"amount": "3.14",
	"remark": "测试增加数据3.14"
}
说明： 来源于员工登录帐号，和第三方系统的员工唯一标识、勤策的员工唯一标识不能同时为空

参数说明：

参数 类型 必填 说明
sourceCode VARCHAR(200) 否 第三方系统的员工唯一标识
userId VARCHAR(64) 否 勤策的员工唯一标识
userCode VARCHAR(64) 否 员工登录帐号
amount VARCHAR(64) 是 变动积分，仅支持2位小数，新增积分填写正数，扣减积分填写负数
remark VARCHAR(64) 否 备注

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }"
}

# 员工积分变动日志查询接口

接口说明：通过来源于第三方的员工唯一标识，和勤策的员工唯一标识、员工登录账号以及时间范围查询员工积分变动日志

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/bonuspoints/v1/queryuserbpchange/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "sourceCode":"testyuangong",
    "userId": "5119344588087994379",
    "userCode": "14252552555",
    "beginTime": "2019-10-12",
    "endTime": "2024-10-11"
}
说明： 来源于员工登录帐号，和第三方系统的员工唯一标识、勤策的员工唯一标识不能同时为空

参数说明：

参数 类型 必填 说明
sourceCode VARCHAR(200) 否 第三方系统的员工唯一标识
userId VARCHAR(64) 否 勤策的员工唯一标识
userCode VARCHAR(64) 否 员工登录帐号
beginTime VARCHAR(64) 否 查询开始时间，格式：yyyy-MM-dd
endTime VARCHAR(64) 否 查询结束时间，格式：yyyy-MM-dd

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
	{
		"code": "STORE2021081201539",
		"name": "qinqiang_test",
		"id": "5108521383450986770",
		"source_code": "kehucode",
		"list": [
			{
				"changeTime": "2023-01-18 15:00:48",
				"changeBp": "23.11",
				"operateType": "接口同步增加",
				"code": "14252552555",
				"name": "员工测试"
			},
			{
				"changeTime": "2020-07-24 20:21:02",
				"changeBp": "6.00",
				"operateType": "销量",
				"code": "14252552555",
				"name": "员工测试"
			},
			{
				"changeTime": "2020-07-24 20:21:02",
				"changeBp": "120.00",
				"operateType": "销售额",
				"code": "14252552555",
				"name": "员工测试"
			},
			{
				"changeTime": "2020-07-24 20:21:03",
				"changeBp": "2.00",
				"operateType": "销量",
				"code": "14252552555",
				"name": "员工测试"
			},
			{
				"changeTime": "2020-07-24 20:21:03",
				"changeBp": "40.00",
				"operateType": "销售额",
				"code": "14252552555",
				"name": "员工测试"
			}
		]
	}
]

参数说明：

参数 类型 说明
code VARCHAR(100) 员工登录账号
name VARCHAR(100) 员工姓名
id VARCHAR(100) 勤策的员工唯一标识
source_code VARCHAR(200) 第三方系统的员工唯一标识
list.changeTime VARCHAR(200) 变更时间
list.changeBp VARCHAR(200) 变更积分
list.operateType VARCHAR(200) 变更类型
list.code VARCHAR(200) 创建人账号
list.name VARCHAR(200) 创建人姓名

← 任务激励接口 →