添加事件

如下所述，您可以通过 开发者控制台 或我们的 API 为您的某个应用创建一个新事件。

端点

方法	URL
POST	https://ws.catappult.io/api/events

身份验证

要访问此 API，您需要在 Aptoide Connect 上拥有有效的账户订阅，并使用 API 密钥进行身份验证（请查看此处了解如何生成密钥）。

⚠️

所需账户类型

事件只能由 Developer 类型的账户创建、编辑或删除。

标头

标头	类型	是否必填	说明
Api-Key	string	必填	用于验证您的 API 请求。该值为您的 Aptoide Connect API 密钥。

请求体参数

该端点接受 application/json 或 multipart/form-data。文件上传需要使用 multipart/form-data。

参数	类型	是否必填	说明
applicationName	string	必填	该事件所属应用的唯一包名（例如 com.example.test）。
name	string	必填	事件的显示名称。
type	string	可选	事件类型（例如 CUSTOM）。有效值请参阅列出可用事件类型。
startTimestamp	string	可选	事件开始日期/时间。格式：YYYY-MM-DD HH:mm:ss。
endTimestamp	string	可选	事件结束日期/时间。格式：YYYY-MM-DD HH:mm:ss。
allowedPartners	string	可选	以逗号分隔的合作伙伴标识符列表（例如 APTOIDE-GAMES,APTOIDE-VANILLA）。有效值请参阅列出可用合作伙伴。
locales[<localeName>][description]	string	可选	给定区域设置的简短描述（例如 en_GB）。
locales[<localeName>][longDescription]	string	可选	给定区域设置的详细描述。
locales[<localeName>][files][<index>]	file	可选	给定区域设置的素材文件，以 multipart/form-data 形式发送。使用带索引的键（[0]、[1]、…）可上传多个文件。服务器会根据每个文件的尺寸自动推导其 ratio。

示例

通过 JSON 创建事件

curl -X POST "https://ws.catappult.io/api/events" \
  -H "Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationName": "com.example.test",
    "name": "Spring Event",
    "type": "CUSTOM",
    "startTimestamp": "2027-01-01 00:00:00",
    "endTimestamp": "2027-01-02 00:00:00",
    "allowedPartners": "APTOIDE-GAMES,APTOIDE-VANILLA",
    "locales": {
      "en_GB": {
        "description": "Short description",
        "longDescription": "Long description"
      }
    }
  }'

通过 multipart/form-data 创建带有区域设置文件的事件

curl -X POST "https://ws.catappult.io/api/events" \
  -H "Api-Key: <YOUR_API_KEY>" \
  -F "applicationName=com.example.test" \
  -F "name=Spring Event" \
  -F "type=CUSTOM" \
  -F "startTimestamp=2027-01-01 00:00:00" \
  -F "endTimestamp=2027-01-02 00:00:00" \
  -F "allowedPartners=APTOIDE-GAMES" \
  -F "locales[en_GB][description]=Short description" \
  -F "locales[en_GB][longDescription]=Long description" \
  -F "locales[en_GB][files][0]=@/path/to/asset-1.webp" \
  -F "locales[en_GB][files][1]=@/path/to/asset-2.webp"

响应

成功

如果 API 调用返回 HTTP 200 状态码，则表示请求成功，事件已创建。响应体为新创建事件的 uid（一个 UUID 字符串）。

响应示例

"538aaa1b-c3a2-40a5-97dd-6bf20645482e"