添加或编辑应用内商品
您可以通过此 API 端点在单个请求中添加新的应用内商品或更新现有商品。如果具有给定 sku 的应用内商品不存在,则将创建它。如果它已存在,则将使用所提供的值进行更新。
端点
| 方法 | URL |
|---|---|
| PUT | https://ws.catappult.io/api/applications/{applicationName}/consumables/{sku} |
身份验证
要访问此 API,您需要在 Aptoide Connect 上拥有有效的账户订阅,并使用 API 密钥进行身份验证(请查看此处了解如何生成密钥)。
⚠️
所需账户类型
应用内商品只能由类型为 Developer 的账户创建或编辑。
标头
| 标头 | 类型 | 是否必需 | 说明 |
|---|---|---|---|
Api-Key | string | 必需 | 用于对您的 API 请求进行身份验证。其值为您的 Aptoide Connect API 密钥。 |
路径参数
| 参数 | 类型 | 说明 |
|---|---|---|
applicationName | string | 应用程序的唯一包名(例如 com.example.test)。 |
sku | string | 要添加或更新的应用内商品的唯一标识符(例如 product01)。 |
查询参数
参数 | 类型 | 是否必需 | 说明 |
|---|---|---|---|
|
| 可选(默认值: | 指定应用内商品的操作系统。可能的值: |
请求体参数
⚠️
重要
所有参数都必须始终作为表单数据(multipart/form-data)发送,即使您提供的是 URL 而非上传文件时也是如此。
不支持 JSON 请求。请在 cURL 中使用 -F 标志来发送每个字段。
注意事项:
- 如果未定义特定国家/地区的零售价格,最终收费将在购买时根据参考价格自动换算。
- 所有 countryPrices 参数(
countryPrices[<country_code>][...])均可使用任何受支持的 ISO 3166-1 alpha-2 国家/地区代码。 - 所有 locale 参数(
locales[<language_code>][...])均可使用任何 ISO 639 语言代码。您可以一次为多种语言提供 locale 参数,但只能将其中一个设置为默认。
| 参数 | 类型 | 是否必需 | 说明 |
|---|---|---|---|
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 中应用内商品 product01 的示例,参考价格为 1 EUR,美利坚合众国(US)的特定国家/地区价格设置为 2 USD,并包含英语(en)的本地化内容(cURL)
curl -X PUT "https://ws.catappult.io/api/applications/com.example.app/consumables/product01?operatingSystem=android" \
-H "Api-Key: YOUR_API_KEY" \
-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"