メインコンテンツまでスキップ

编辑活动

您可以通过 Aptoide Connect 开发者控制台，或通过此 API 端点以编程方式更新现有活动。

端点​

方法URL
PATCHhttps://ws.catappult.io/api/events/{uid}

身份验证​

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

⚠️
所需账户类型

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

请求头​

请求头类型是否必需描述
Api-Keystring必需用于验证您的 API 请求。该值为您的 Aptoide Connect API 密钥。

路径参数​

参数类型描述
uidstring活动的唯一标识符（UUID）（例如 56fd535b-b071-402c-a4fa-29807eb050c9）。

请求体参数​

所有请求体参数均为可选 —— 仅会更新您在请求中包含的字段。该端点接受 application/json 或 multipart/form-data。

参数类型描述
namestring更新活动的显示名称。
startTimestampstring新的活动开始日期/时间。格式：YYYY-MM-DD HH:mm:ss。
endTimestampstring新的活动结束日期/时间。格式：YYYY-MM-DD HH:mm:ss。
allowedPartnersstring以逗号分隔的合作伙伴标识符列表（例如 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。
locales[<localeName>][filesIds]string以逗号分隔的、需保留的现有文件 ID 列表（例如 863,953）。任何 ID 未列出的现有文件都将被移除。与 files[<index>] 结合使用，可保留部分文件并添加新文件。
⚠️
注意

更新某个区域设置会替换该区域设置的整个条目，因此您未包含的任何字段（包括已上传的 files）都将被清除。要保留先前上传的文件，请在 filesIds 中列出它们的 ID。

文件上传需要使用 multipart/form-data —— 它们无法通过 JSON 发送。

示例​

通过 JSON 更新文本字段

curl -X PATCH "https://ws.catappult.io/api/events/56fd535b-b071-402c-a4fa-29807eb050c9" \
  -H "Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Event Name",
    "startTimestamp": "2026-02-04 00:30:00",
    "endTimestamp": "2026-04-30 00:00:00",
    "allowedPartners": "APTOIDE-GAMES,APTOIDE-VANILLA",
    "locales": {
      "en_GB": {
        "description": "Test",
        "longDescription": "Test"
      }
    }
  }'

通过 multipart/form-data 上传区域设置文件

curl -X PATCH "https://ws.catappult.io/api/events/56fd535b-b071-402c-a4fa-29807eb050c9" \
  -H "Api-Key: <YOUR_API_KEY>" \
  -F "locales[en_GB][description]=Test" \
  -F "locales[en_GB][longDescription]=Test" \
  -F "locales[en_GB][files][0]=@/path/to/asset-1.webp" \
  -F "locales[en_GB][files][1]=@/path/to/asset-2.webp"

保留现有文件并添加新文件

curl -X PATCH "https://ws.catappult.io/api/events/56fd535b-b071-402c-a4fa-29807eb050c9" \
  -H "Api-Key: <YOUR_API_KEY>" \
  -F "locales[en_GB][description]=Test" \
  -F "locales[en_GB][longDescription]=Test" \
  -F "locales[en_GB][filesIds]=863,953" \
  -F "locales[en_GB][files][0]=@/path/to/new-asset.webp"

响应​

成功​

如果 API 调用返回 HTTP 200 状态码，则表示请求成功，活动已被更新。

响应示例​

"Event updated."