编辑应用内订阅

🚧

正在开发的功能

应用内订阅目前正在开发中，即将发布。此端点在发布前可能会发生变化。

您可以通过 Aptoide Connect 开发者控制台或使用此 API 端点以编程方式更新应用程序的现有应用内订阅。

端点

方法	URL
PATCH	https://ws.catappult.io/api/applications/{applicationName}/subscriptions/{sku}

身份验证

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

⚠️

所需账户类型

只有 Developer 类型的账户才能编辑应用内订阅。

标头

标头	类型	是否必需	说明
Api-Key	string	必需	用于对您的 API 请求进行身份验证。该值是您的 Aptoide Connect API 密钥。

路径参数

参数	类型	说明
applicationName	string	应用程序的唯一包名（例如 com.example.test）。
sku	string	要更新的应用内订阅的唯一标识符（例如 subscription01）。

查询参数

参数	类型	是否必需	说明
operatingSystem	string (URL)或 file	可选（默认值：android）	指定应用内订阅的操作系统。可能的值： • android • ios

主体参数

⚠️

重要

所有参数都必须始终以表单数据（multipart/form-data）形式发送，即使您提供的是 URL 而非上传文件。

不支持 JSON 请求。在 cURL 中使用 -F 标志来发送每个字段。

注意事项：

• 如果未定义特定国家/地区的零售价格，最终费用将在购买时从参考价格自动转换。
• 所有 countryPrices 参数（countryPrices[<country_code>][...]）均可使用任何受支持的 ISO 3166-1 alpha-2 国家/地区代码。
• 所有 locale 参数（locales[<language_code>][...]）均可使用任何 ISO 639 语言代码。您可以一次性为多种语言提供 locale 参数，但只能将其中一种设置为默认。

参数	类型	是否必需	说明
period	string	必需	ISO 8601 格式的周期。参见可用周期。
gracePeriod	string	可选	ISO 8601 格式的宽限期。参见可用宽限期。
freeTrialPeriod	string	可选	ISO 8601 格式的免费试用期。参见可用免费试用期。
referencePriceCurrency	string	必需	参考价格的 ISO 4217 货币代码。参见可用货币代码。
referencePriceAmount	string	必需	参考价格的数值。
countryPrices[<country_code>]	string	可选	在指定国家/地区的价格。
locales[<language_code>][title]	string	可选	指定语言的标题。
locales[<language_code>][description]	string	可选	指定语言的描述。
locales[<language_code>][isDefault]	boolean	可选	将此语言设置为默认。

响应

成功

如果 API 调用返回 HTTP 200 状态码，则表示请求成功，应用内订阅已成功更新。

示例

应用 com.example.app 中应用内订阅 subscription01 的示例，周期为 1 周、宽限期为 3 天、免费试用期为 3 天、参考价格为 1 EUR、针对美利坚合众国（US）设置的特定国家/地区价格为 2 USD，并附带英语（en）的本地化内容（cURL）

curl -X PATCH "https://ws.catappult.io/api/applications/com.example.app/subscriptions/subscription01?operatingSystem=android" \
  -H "Api-Key: YOUR_API_KEY" \
  -F "period=P1W" \
  -F "gracePeriod=P3D" \
  -F "freeTrialPeriod=P3D" \
  -F "referencePriceCurrency=EUR" \
  -F "referencePriceAmount=1" \
  -F "countryPrices[US]=2" \
  -F "locales[en][title]=Title" \
  -F "locales[en][description]=Description" \
  -F "locales[en][isDefault]=true"