内容变更通知

本文档介绍内容定制输出内容发生变更时的通知机制。
当内容定制侧输出的内容发生变更时，内容定制侧将推送变更事件到客户侧配置的回调地址。客户侧根据通知可以调用接口更新内容信息。

接入内容定制对外内容推送，客户侧需要按照如下步骤完成：

1. 在【内容定制平台-内容同步】的【回调配置】中生成并获取鉴权密钥

2. 在上述相同页面中配置回调接收地址

3. 依据接口文档和平台相关配置开发实现业务逻辑

4. 在上述相同页面中点击“测试”以发送测试数据，测试接口连通性

5. 在保证接口连通之后，开始内容输出的推送

上述过程如图所示：

请求方式

HTTPS

method：POST
	
Content-Type：application/json
	

签名校验

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

签名参数

签名算法

Hmac_SHA256算法

签名步骤

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

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

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

签名示例

检验signature的Go示例代码：

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

请求参数

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

Header

Body

event_type

StatusChangeEventData

响应参数

响应方指“客户侧”。

请求示例

POST / HTTP/1.1
Host: xxx.xxx.xxx
Content-Type: application/json
X-Content-Timestamp: 1689585543
X-Content-Nonce: kfcv50
X-Content-Signature: 2d3891cee3dcc777ba27a29f70758c581e93f21f3dad1deeaadf11aa440fe4b2
{
    "event_id": "177165499009xxxx",
    "event_type": "status_change",
    "group_id": "690150925257885xxxx",
    "event_data": "{\"is_available\":false}",
    "uniq_key": "56b74c26a28699e1829a4390dca58f89e54a507dcf8df6a49a4246039c31c190",
    "event_time": 1689585542
}

响应示例

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

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

注意事项