小红书投放广告看这里｜小红书核心代理｜数据对接-表单客资API回传至客户CRM

聚光表单投放-线索管理获取线索列表 api 对接开发说明（对外）使用指引 

1、对接流程

第一步：在落地页-数据推送功能处填写有效的post消息接收地址

第二步：发送测试消息进行联调测试（response code必须为200才可联调成功）

第三步：使用联调成功的落地页进行投放，api实时回传表单数据

2、平台功能截图

3、消息发送

用户提交表单后，将以post请求的方式将信息以json数据格式推送到在落地页配置页面中填写的消息接收地址。如果返回的responsecode为200，则表示推送成功。对于推送失败的情况，系统将每隔30秒进行一次重试，多重试3次。

地址格式要求：

消息接收地址必须是一个对外开放的http服务url，能够接受post请求。

例如：https://example.com/leads

4、签名验证

为了确保消息来源于小红书，可以选择对post数据的来源进行安全认证（非必须），验证方法如下：

-解析post消息header中的x-red-signature参数（格式为sha1=5bf9f4192d049dfe442edbcd533223673bb188e4）。

- 解析post消息的request body（原始未经反序列化的原始body数据）。

-使用落地页配置页面获取的token作为secretkey，与body数据生成签名，并与header中的signature进行校验。

java示例代码：

```

// java示例代码

// 签名验证

public boolean verifysignature(uest request,string secretkey) {

    string signatureheader =re("x-red-signature");

    if (signatureheader != null) {

        string[] signatureparts =signatureheader.split("=");

        if (signatureparts.length == 2){

            string algorithm =signatureparts[0];

            string signature =signatureparts[1];

            string re =getre(request);

            // 生成签名

            stringgeneratedsignature = generatesignature(re, secretkey);

            // 校验签名

            if(uals("sha1") &&uals(generatedsignature)) {

                returntrue;

            }

        }

    }

    return false;

}

```

python示例代码：

```

# python示例代码

# 签名验证

def verify_signature(request, secret_key):

    signature_header =re('x-red-signature')

    if signature_header:

        signature_parts =signature_header.split('=')

        if len(signature_parts) == 2:

            algorithm =signature_parts[0]

            signature =signature_parts[1]

            re =get_re(request)

            # 生成签名

            generated_signature =generate_signature(re, secret_key)

            # 校验签名

            if algorithm == 'sha1'and signature == generated_signature:

                returntrue

    return false

```

推送消息示例：直接提供包含姓名、电话、邮箱、性别、地址、单选、多选、文本、数值等类型代码示例的消息推送示例。

签名验证demo（java）：提供了java版本的签名验证示例代码。

常见q&a

q1、表单的api回传中，默认会包含用户提交表单的地域数据吗？还是必须由客户定义字段来收集并回传？

a：只支持通过地址或门店组件等方式记录或传递地域数据，默认不会包含。

q2、用户在表单落地页提交成功后，但在客户crm系统中查询不到信息，该如何解决？

a：可能有以下情况：1）小红书在对外传输数据时采用了根据用户id和落地页id去重的机制，因此同一页面多次提交相同手机号只会传输一次。这一般发生在客户内部员工测试链路时，建议客户更换手机号进行测试。2）确认是否在测试数据发送时没有配置api，如果是，请建议客户更换用户账号重新提交。如果问题仍然存在，请按照排查模板提交问题以便进一步排查。

q3、api回传是否支持上传加密文件？

a：不支持。

q4、api回传是否支持区分搜索和信息流？

a：支持，可以使用字段channel进行区分。

q5、url字段是指落地页的url吗？是否需要编码？

a：url字段是指发送地址，并不是落地页地址，与编码无关。

q6、表单数据中的label值是由表单定义的值吗？

a：是的，label值由表单定义决定。

q7、文档中的参数中没有渠道号信息，如果希望在url中携带渠道号来区分数据，应该如何操作？

a：不支持定制参数。

q8、落地页的token是每个表单都不同，还是一个账户下共用一个token？

a：落地页的token是在专业号下唯一的。