小红书广告推广表单的 API 对接

小红书广告推广

表单 API 对接

1. 表单数据 API 对接文档

1.1 对接流程

首先，在落地页的“数据推送功能”处填写有效的 POST 消息接收地址。其次，发送测试消息展开联调测试，只有 response code 为 200 时才能联调成功。最后，使用联调成功的落地页进行投放，API 会实时回传表单数据。

1.2 平台功能截图

1.3 消息发送

在小红书广告推广中，当用户提交表单时，会以 POST 请求和 JSON 数据格式，将信息推送到在落地页配置页面所填写的消息接收地址。若 response code 为 200 则认定推送成功。对于推送失败的情况，会每隔 30 秒重试一次，最多重试 3 次。

地址格式要求：必须是对外开放的、能够接受 PSOT 请求的 http 服务 URL。

例如：

http://example.com/leads

1.4 签名验证

为保障消息来源确为小红书，可选择对 POST 数据的来源进行安全认证（并非强制要求），具体验证方式如下：

● 解析 POST 消息 header 中的 X-Red-Signature 参数（格式为 sha1=5bf9f4192d049dfe442edbcd533223673bb188e4）

● 解析 POST 消息的 request body（未经反序列化的原始 body 数据）

● 以落地页配置页面获取的 token 作为 secretKey，结合 body 数据生成签名，并与 header 中的 signature 进行校验

直接给出包含姓名、电话、邮箱、性别、地址、单选、多选、文本、数值等类型的代码示例

2. 有效表单回传 API 对接文档

当下，如果客户在落地页“数据推送功能”处填写了有效的 POST 消息接收地址，那么用户提交的表单数据会通过小红书广告推广表单数据 API 回传给客户。所谓有效表单，指的是用户通过广告点击跳转建站落地页后进行留资，客户收到线索后通过电话、微信等方式回访用户，确认用户转化意向的表单。本 API 主要解决的就是有效表单回传的问题。

2.1 操作流程

1. 在小红书广告推广的落地页“数据推送功能”处填写有效的 POST 消息接收地址。

2. 发送测试消息进行联调测试，只有 response code 为 200 时联调才算成功。

3. 运用联调成功的落地页进行投放，API 实时回传表单数据。

4. 通过接口回传表单相关数据，回传的表单数据会默认属于有效表单。

2.2 接口说明

请求地址：

https://www.xiaohongshu.com/api/hawking/leads/return

请求方法：POST

请求头：Content-Type:application/json

2.3 参数解释

2.4 请求示例

curl -X POST –header ‘Content-Type: application/json’ –header ‘Accept: text/json’ -d ‘{“campaignId”: 1834295,”creativityId”: 9725765,”leadsId”: “61935e4f2e299c0001fea6e8″,”unitId”: 2244696}’ ‘https://www.xiaohongshu.com/api/hawking/leads/return’

‘正确返回：{“result”: 0,”success”: true,”msg”: “success”}