事件推送是指火山引擎内容定制服务调用客户提供的接口，推送变更事件。

请求方式

• HTTPS
• Method：POST
• Content-Type：application/json

签名校验

客户侧通过检验 signature 对请求进行校验（下面有校验方式），以确认请求来自内容定制系统。

签名参数

签名算法

Hmac_SHA256算法

签名步骤

1. 将 timestamp、nonce 和 payload 依次进行拼接；

2. 使用 secret_key 对上述拼接的字符串进行 hmac sha256 加密，然后转成十六进制字符串 ；

3. 得到加密后的字符串可与 signature 对比，标识该请求来源于内容定制的内容事件推送。

签名示例

检验signature的Java示例代码：

public static String genSignature(String timestamp, String nonce, String body, String secretKey) throws NoSuchAlgorithmException, InvalidKeyException {
    // 按照 timestamp,nonce,body 顺序拼接签名字符串
    String signatureStr = timestamp + nonce + body;
    // 进行 hmac sha256 加密
    Mac hmacSha256 = hmacSha256 = Mac.getInstance("HmacSHA256");
    SecretKeySpec secretKeySpec = new SecretKeySpec(secretKey.getBytes(StandardCharsets.UTF_8), "HmacSHA256");
    hmacSha256.init(secretKeySpec);
    byte[] signatureBytes = hmacSha256.doFinal(signatureStr.getBytes(StandardCharsets.UTF_8));
    // 将 sha256 字节数组转成16进制字符串
    StringBuilder signatureBuilder = new StringBuilder();
    for (byte signatureByte : signatureBytes) {
        String hex = Integer.toHexString(signatureByte & 0xFF);
        if (hex.length() == 1) {
            signatureBuilder.append('0');
        }
        signatureBuilder.append(hex);
    }
    return signatureBuilder.toString();
}

检验signature的Go示例代码：

func GenSignature(timestamp, nonce, body, secretKey string) string {
    // 按照 timestamp,nonce,body 顺序拼接签名字符串
    signatureStr := timestamp + nonce + body
    // 进行 hmac sha256 加密
    hmacSha256 := hmac.New(sha256.New, []byte(secretKey))
    hmacSha256.Write([]byte(signatureStr))
    // 将 sha256 字节数组转成16进制字符串
    signature := fmt.Sprintf("%x", hmacSha256.Sum(nil))
    return signature
}

请求参数

请求方指“火山引擎-内容定制”。

Header

Body

• 事件结构见事件章节

• 事件具体枚举件POI事件和内容事件部分

响应参数

响应方指“客户侧”。

请求示例

POST / HTTP/1.1
Host: xxx.xxx.xxx
Content-Type: application/json
X-Content-Timestamp: 1690366367
X-Content-Nonce: kfcv50
X-Content-Signature: 2d3891cee3dcc777ba27a29f70758c581e93f21f3dad1deeaadf11aa440fe4b2
Body: ${参考事件章节中的事件结构部分}

注意： 这里的Body应该作为一个字符串接收。不要利用引入的SDK或者框架的能力作为一个JSONObject接收，再转为字符串，这样可能导致Body的字符串内容不一致，从而导致签名计算出来的最终结果不一致。

响应示例

客户侧服务端返回给火山引擎侧的响应数据

{
    "ret": 0, // 响应状态码
    "msg": "success" // 响应信息
}

公共部分

[{
    "Product": "interest_map", // 业务线，本场景中统一为interest_map
    "EventId": "7339149900963496457", // 事件唯一ID
    "EventType": "poi_created", // 事件类型
    "EntityType": "poi", // 事件主体
    "EntityId": "7339149900963496450", // 事件主体ID
    "EventTimeMillisec": "1708940969000", // 事件产生时间
    "EventData": "" // 事件数据，经过序列化后的事件结构体，不同事件类型下不同
}]

领域事件

{
    "Product": "interest_map",
    "EventId": "7339149900963496457",
    "EventType": "poi_created",
    "EntityType": "poi",
    "EntityId": "7339149900963496450",
    "EventTimeMillisec": "1708940969000"
}

{
    "Product": "interest_map",
    "EventId": "7339149900963496457",
    "EventType": "poi_updated",
    "EntityType": "poi",
    "EntityId": "7339149900963496450",
    "EventTimeMillisec": "1708940969000"
}

// Event
{
    "Product": "interest_map",
    "EventId": "7339149900963496457",
    "EventType": "poi_removed",
    "EntityType": "poi",
    "EntityId": "7339149900963496450",
    "EventTimeMillisec": "1708940969000"
}