添加应用内订阅

🚧

正在开发的功能

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

如下所述，您可以通过开发者控制台或我们的 API 在 Aptoide Connect 上向您的应用程序添加应用内订阅。

端点

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

身份验证

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

⚠️

所需账户类型

应用内订阅只能由类型为 Developer 的账户创建。

标头

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

路径参数

参数	类型	说明
applicationName	string	标识将为其创建应用内订阅的应用程序。（例如 com.example.test）。

查询参数

参数	类型	是否必需	说明
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 参数，但只能将其中一个设置为默认。

参数	类型	是否必需	说明
sku	string	必需	应用内订阅的唯一标识符（例如 subscription01）。
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 周，宽限期为 0 天，参考价格为 1 USD，葡萄牙（PT）的特定国家/地区价格设置为 2 EUR，并包含西班牙语（es）和葡萄牙语（pt）的本地化内容（cURL）：

curl -X POST "https://ws.catappult.io/api/applications/com.example.app/subscriptions?operatingSystem=android" \
  -H "Api-Key: YOUR_API_KEY" \
  -F "sku=subscription01" \
  -F "period=P1W" \
  -F "gracePeriod=P0D" \
  -F "referencePriceCurrency=USD" \
  -F "referencePriceAmount=1" \
  -F "countryPrices[PT]=2" \
  -F "locales[es][title]=Titulo" \
  -F "locales[es][description]=Descripcion" \
  -F "locales[es][isDefault]=true" \
  -F "locales[pt][title]=Titulo" \
  -F "locales[pt][description]=Descricao" \
  -F "locales[pt][isDefault]=false"