小红书广告推广表单API对接指南
1. 对接步骤
第一步:在落地页的数据推送功能中设置一个有效的POST消息接收地址。
第二步:发送测试消息进行联调测试,确保响应码为200表示联调成功。
第三步:使用测试成功的落地页进行广告投放,API将实时回传表单数据。
2. 平台功能截图
https://21491542.s21i.faiusr.com/4/ABUIABAEGAAgg-KIqgYohP3G1gUwtAw47wk.png
3. 消息发送机制
当用户在小红书广告推广中提交表单后,系统会将用户信息以POST请求的形式,通过JSON格式发送到您在落地页配置中设置的消息接收地址。若响应码为200,则视为推送成功。若推送失败,系统会在30秒后重试,Zui多重试3次。
地址格式要求:必须是对外开放的、能够接收POST请求的HTTP服务URL。
示例地址:http://example.com/leads
4. 签名验证(可选)
为了验证消息来源的安全性,您可以对POST数据进行安全认证。
验证步骤:
解析POST消息头部的X-Red-Signature参数。
获取POST消息的请求体(原始body数据)。
使用在落地页配置页面获取的token作为secretKey,与body数据生成签名,并与头部的signature进行比对。
示例代码:提供Java和Python的示例代码。
推送消息示例:提供包含姓名、电话、邮箱、性别、地址、单选、多选、文本、数值等字段的代码示例。
签名验证示例(Java):展示如何进行签名验证的示例代码。
5. 有效表单回传API对接
若客户在落地页数据推送功能处填写了有效的POST消息接收地址,用户提交的表单数据将通过小红书广告推广表单数据API回传给客户。有效表单是指用户通过广告点击后,在落地页留资,并通过电话、微信等形式回访确认转化意向的表单。
操作流程:
在落地页数据推送功能处填写有效的POST消息接收地址。
发送测试消息进行联调测试,确保响应码为200。
使用测试成功的落地页进行投放,API将实时回传表单数据。
接口回传的表单数据默认为有效表单。
接口说明:
参数解释:
https://21491542.s21i.faiusr.com/4/ABUIABAEGAAgw-KIqgYomLTy0
请求示例:
bashcurl -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'
正确返回:
json{
"result": 0,
"success": true,
"msg": "success"