促销列表

您可以通过 Aptoide Connect 开发者控制台或以编程方式使用此 API 端点，检索与您账户关联的促销列表。

端点

方法	URL
GET	https://ws.catappult.io/api/promotions

身份验证

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

标头

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

查询参数

参数	类型	是否必填	说明
type	string	可选	按类型筛选促销（例如 SEARCH）。
applicationName	string	可选	按应用的唯一包名筛选促销（例如 com.example.test）。
partnerName	string	可选	筛选 partner.name 与给定标识符匹配的促销（例如 APTOIDE-GAMES）。有效值请参阅列出可用合作伙伴。
startsAfter	string (date)	可选	仅返回 startTimestamp 在给定日期之后的促销。格式：YYYY-MM-DD。
startsBefore	string (date)	可选	仅返回 startTimestamp 在给定日期之前的促销。格式：YYYY-MM-DD。
endsAfter	string (date)	可选	仅返回 endTimestamp 在给定日期之后的促销。格式：YYYY-MM-DD。
endsBefore	string (date)	可选	仅返回 endTimestamp 在给定日期之前的促销。格式：YYYY-MM-DD。

请求示例

curl -X GET "https://ws.catappult.io/api/promotions" \
  -H "Api-Key: <YOUR_API_KEY>"

响应

成功

如果 API 调用返回 HTTP 200 状态码，则表示请求成功，并返回一个与已验证账户关联的促销对象的数组。

当某项促销（通过 eventUid）链接到某个事件时，event 字段包含该事件的嵌入式表示；否则其值为 null。

响应示例

[
  {
    "uid": "9dbf70ff-30a4-4d82-b062-42ab24126e59",
    "name": "Test Promotion 1",
    "type": "SEARCH",
    "status": "active",
    "startTimestamp": "2026-03-16 00:00:00",
    "endTimestamp": "2026-04-30 00:00:00",
    "createdAt": "2026-03-26 20:47:20",
    "updatedAt": "2026-04-01 14:23:34",
    "hasStatistics": false,
    "event": {
      "uid": "56fd535b-b071-402c-a4fa-29807eb050c9",
      "name": "Test Event",
      "type": "CUSTOM",
      "status": "active",
      "startTimestamp": "2026-02-04 00:30:00",
      "endTimestamp": "2026-04-30 00:00:00",
      "createdAt": "2026-02-05 16:06:33",
      "updatedAt": "2026-04-20 15:01:53",
      "allowedPartners": ["APTOIDE-GAMES"],
      "application": {
        "name": "com.aptoide.diceroll.sdk",
        "title": "Aptoide Diceroll SDK",
        "iconUrl": "https://ws.catappult.io/api/applications/com.aptoide.diceroll.sdk/icon",
        "featureGraphicUrl": "https://ws.catappult.io/api/applications/com.aptoide.diceroll.sdk/featureGraphic"
      },
      "data": {
        "allowedPartners": "APTOIDE-GAMES",
        "applySameFilesToAllLocales": "false"
      },
      "locales": [
        {
          "localeName": "en_GB",
          "description": "Test",
          "longDescription": "Test",
          "files": [
            {
              "id": 953,
              "name": "b737866e7065a09e02a8393dd4c83a42_com-aptoide-diceroll-sdk-none-promotion-asset.webp",
              "downloadUrl": "https://cdn-catappult.aptoide.com/promotion_asset/b737866e7065a09e02a8393dd4c83a42_com-aptoide-diceroll-sdk-none-promotion-asset.webp",
              "ratio": "256:125"
            }
          ]
        }
      ]
    },
    "partner": { "name": "APTOIDE-GAMES" },
    "application": {
      "name": "com.aptoide.diceroll.sdk",
      "title": "Aptoide Diceroll SDK",
      "operatingSystem": "android",
      "iconUrl": "https://ws.catappult.io/api/applications/com.aptoide.diceroll.sdk/icon",
      "featureGraphicUrl": "https://ws.catappult.io/api/applications/com.aptoide.diceroll.sdk/featureGraphic"
    },
    "data": {
      "name": "Test Promotion 1",
      "oemId": "562c8031d4a08ba95e682a800cd04448",
      "utmContent": "search"
    },
    "files": [
      {
        "id": 385,
        "name": "64c5826a724c1bb78332c0ed67b5f83b_com-aptoide-diceroll-sdk-none-promotion-asset.png",
        "downloadUrl": "https://cdn-catappult.aptoide.com/promotion_asset/64c5826a724c1bb78332c0ed67b5f83b_com-aptoide-diceroll-sdk-none-promotion-asset.png"
      }
    ]
  }
]

错误

HTTP 状态	代码	说明
404	PARTNER-NOT-FOUND	与该 API 密钥关联的账户没有链接的合作伙伴记录。