アプリ内サブスクリプションの追加または編集

🚧

開発中の機能

アプリ内サブスクリプションは現在開発中であり、まもなくリリースされます。このエンドポイントはローンチ前に変更される可能性があります。

この API エンドポイントを介して、単一のリクエストで新しいアプリ内サブスクリプションを追加するか、既存のものを更新できます。指定された sku を持つアプリ内サブスクリプションが存在しない場合は作成されます。すでに存在する場合は、提供された値で更新されます。

エンドポイント

メソッド	URL
PUT	https://ws.catappult.io/api/applications/{applicationName}/subscriptions/{sku}

認証

この API にアクセスするには、Aptoide Connect でアクティブなアカウントサブスクリプションを保有し、API キーで認証する必要があります（生成方法はこちらを確認してください）。

⚠️

必要なアカウントタイプ

アプリ内サブスクリプションは、Developer タイプのアカウントによってのみ作成または編集できます。

ヘッダー

ヘッダー	型	必須	説明
`Api-Key`	`string`	必須	API リクエストの認証に使用されます。値は Aptoide Connect の API キーです。

パスパラメータ

パラメータ	型	説明
`applicationName`	`string`	アプリケーションの一意のパッケージ名（例: `com.example.test`）。
`sku`	`string`	追加または更新するアプリ内サブスクリプションの一意の識別子（例: `subscription01`）。

クエリパラメータ

パラメータ	型	必須	説明
`operatingSystem`	`string (URL)`または `file`	任意（デフォルト: `android`）	アプリ内サブスクリプションのオペレーティングシステムを指定します。指定可能な値: • `android` • `ios`

ボディパラメータ

⚠️

重要

すべてのパラメータは、ファイルをアップロードする代わりに URL を指定する場合でも、常にフォームデータ（multipart/form-data）として送信する必要があります。

JSON リクエストはサポートされていません。各フィールドを送信するには、cURL の -F フラグを使用してください。

注記:

国別の小売価格が定義されていない場合、最終的な請求額は購入時に参照価格から自動的に換算されます。
すべての countryPrices パラメータ（countryPrices[<country_code>][...]）には、サポートされている任意の ISO 3166-1 alpha-2 国コードを使用できます。
すべてのロケールパラメータ（locales[<language_code>][...]）には、任意の ISO 639 言語コードを使用できます。複数の言語のロケールパラメータを一度に指定できますが、デフォルトとして設定できるのは 1 つだけです。
period パラメータは変更不可です: 新しいサブスクリプションを作成するときにのみ適用され、既存のサブスクリプションを更新するときには無視されます。

パラメータ	型	必須	説明
`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 PUT "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" 

エンドポイント​

認証​

ヘッダー​

パスパラメータ​

クエリパラメータ​

ボディパラメータ​

レスポンス​

成功​

例​