Skip to content

事件上报

接口描述:根据不同的时间类型,上报对应的内容。

根据上报的事件类型数据,会反应在系统的统计数据中。

📮请求信息

请求地址

POST http://api.upgrade.toolsetlink.com/v1/app/report

请求头 (Headers)

参数名必选类型示例值说明
X-Timestampstring2025-02-17T10:34:55+08:00请求时间 RFC3339格式
X-Noncestringfc812cc0b9b51e8c唯一随机字符串(至少16位)
X-AccessKeystringmui2W50H1j-OC4xD6PgQag密钥 AccessKey
X-Signaturestring3603437250c2df51fc46426ac79d8995请求签名 签名规则
Content-Typestringapplication/json

🔐 防重放攻击机制

  1. 服务端验证时间戳与服务器时间差值不超过±5分钟
  2. 服务端会校验Nonce值是否已存在(防止重复请求)

请求体 (Body) 参数说明

参数名必选类型示例值说明                       
eventType string app_start 事件类型:
app_start 应用启动事件
app_upgrade_download 应用升级-下载事件
app_upgrade_upgrade 应用升级-升级事件
devModelKey string stv1 设备机型唯一标识
devKey string 89c8b3d5f2a74e1b 设备唯一标识(可以使用 mac 作为唯一标识)
appKey LOYlLXNy7wV3ySuh0XgtSg LOYlLXNy7wV3ySuh0XgtSg 应用唯一标识, 取值跟 urlKey 与 fileKey 一致
versionCode int 10 当前应用版本号
timestamp string 2025-02-17T10:34:55+08:00 事件发生时间
eventData 扩展字段
(事件类型 app_start 应用启动事件)
- launchTime string 2025-02-17T10:34:55+08:00 应用启动时间 RFC3339格式
eventData 扩展字段
(事件类型 app_upgrade_download 应用升级-下载事件)
- downloadVersionCode int 11 升级策略返回的升级版本
- codeint0
0下载成功
1下载失败(泛用)
1001应用文件下载http错误
1002文件下载空间不足
1003下载文件操作错误,文件(创建/移动/重命名)失败
1004文件MD5校验失败
eventData 扩展字段
(事件类型 app_upgrade_upgrade 应用升级-升级事件)
- upgradeVersionCode int 11 升级策略返回的升级版本
- codeint0
0升级成功
1升级失败(泛用)

请求体示例 (Body)

app_download 应用-下载事件 (在调用 首次下载 接口时,此事件自动录入数据,不需要请求)

json
{
    "eventType": "app_download",
    "appKey": "SkEgKQ4SyLmzazl31fJnAw",
    "versionCode": 1,
    "timestamp": "2025-02-17T10:34:55+08:00"
}

app_start 应用-启动事件

json
{
    "eventType": "app_start",
    "devModelKey": "stv1",
    "devKey": "LOYlLXNy7w",
    "appKey": "SkEgKQ4SyLmzazl31fJnAw",
    "versionCode": 1,
    "timestamp": "2025-02-17T10:34:55+08:00",
    "eventData": {
      "launchTime": "2025-02-17T10:34:55+08:00"
    }
}

app_upgrade_download 应用升级-下载事件

json
{
    "eventType": "app_upgrade_download",
    "devModelKey": "stv1",
    "devKey": "LOYlLXNy7w",
    "appKey": "SkEgKQ4SyLmzazl31fJnAw",
    "versionCode": 1,
    "timestamp": "2025-02-17T10:34:55+08:00",
    "eventData": {
      "downloadVersionCode": 2,
      "code": 0
    }
}

app_upgrade_upgrade 应用升级-升级事件

json
{
    "eventType": "app_upgrade_download",
    "devModelKey": "stv1",
    "devKey": "LOYlLXNy7w",
    "appKey": "SkEgKQ4SyLmzazl31fJnAw",
    "versionCode": 1,
    "timestamp": "2025-02-17T10:34:55+08:00",
    "eventData": {
        "upgradeVersionCode": 2,
        "code": 0
    }
}

📮响应信息

成功响应体

json
{
  "code": 200,
  "msg": "上报成功"
}

典型错误响应体

json
{
  "code": 400002,
  "msg": "参数缺失"
}

📊状态码

http 状态码code场景描述解决方案
2000请求成功
400400001非法请求
400400002参数缺失
400400003参数非法
400400004报头非法
400400005报体非法
401401001鉴权失败
401401002签名验证失败
404404001资源不存在
404404002查询记录不存在
404404003处理方式不存在
404404004请求不存在
500500001服务器内部错误请联系我们 联系我们
500500002服务器内部校验数据失败请联系我们 联系我们