数据对接-私信客资API对接开发说明
使用指引
1、 对接流程
第一步：在私信API功能处填写有效的POST消息接收地址
第二步：发送测试消息进行联调测试（responsecode必须为200才可联调成功）
第三步：联调成功，API实时推送私信线索数据
2、 平台功能截图
聚光后台—工具—线索行业工具
3、消息发送
当客户完成一次有效私信标注（可以是任何平台上的专业号/私信通等，并且可以在在线索管理工具中显示的数据）并完成广告归因时，信息将以POST请求的方式以JSON数据格式推送到已填写在私信API对接页面中的消息接收地址。如果返回的responsecode为200，则表示推送成功。对于推送失败的情况，系统将每隔30秒重试一次，Zui多重试3次。
地址格式要求
接收消息的地址必须是一个对外开放的能够接受POST请求的HTTP服务URL。
例如：http://example.com/leads
4、签名验证
为了确保消息来源于小红书，可以选择对POST数据的来源进行安全认证（非必需），验证的方法如下：
-解析POST消息header中的X-Red-Signature参数（格式为sha1=bf0a961d504467e3ce78c0b9401d311ccc03b395）。
- 解析POST消息的request body（即原始未经反序列化的body数据）。
-使用私信API对接工具获取的token作为secretKey，与body数据生成签名，并与header中的signature进行校验。
推送字段：
| 参数 | 描述 | 值 | 说明 |
| 类型 | 新增/更新内容/更新归因信息 | 新增：新增一条数据 更新内容：更新用户昵称/留资信息/留资状态等 更新归因信息：更新计划ID/单元ID/创意ID | |
| 时间 | 2023/7/21 14:22 | ||
| 小红书号 | 4260721461 | ||
| 用户昵称 | 小红薯111 | ||
| 省份 | 江苏 | ||
| 城市 | 南京 | ||
| 线索标签 | 留客资 | ||
| 电话号码 | |||
| 微信号 | xiaohongshu123 | ||
| 备注 | 已跟进 | ||
| 标注客服 | 留资组件/专业号后台 | ||
| 投放账号 | |||
| 是否留资 | |||
| 笔记链接 | |||
| 广告计划 | |||
| 广告计划ID | |||
| 广告单元 | |||
| 广告单元ID | |||
| 广告创意 | |||
| 广告创意ID | |||
| 私信接收人 | 如果您正在跑KOS/KOB模式，请务必对接该字段 | ||
| 私信接收人id | 如果您正在跑KOS/KOB模式，请务必对接该字段 |