アプリ内サブスクリプションの追加

🚧

開発中の機能

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

以下に説明するように、開発者コンソールまたは当社の API を介して、Aptoide Connect 上のアプリケーションにアプリ内サブスクリプションを追加できます。

エンドポイント

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

認証

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

⚠️

必要なアカウントタイプ

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

ヘッダー

ヘッダー	タイプ	必須	説明
Api-Key	string	必須	API リクエストを認証するために使用されます。値は Aptoide Connect の API キーです。

パスパラメータ

パラメータ	タイプ	説明
applicationName	string	アプリ内サブスクリプションを作成する対象のアプリケーションを識別します。（例: com.example.test）。

クエリパラメータ

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

ボディパラメータ

⚠️

重要

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

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

注記:

• 国別の小売価格が定義されていない場合、最終的な請求額は購入時に参照価格から自動的に換算されます。
• すべての countryPrices パラメータ（countryPrices[<country_code>][...]）は、サポートされている任意の ISO 3166-1 alpha-2 国コードを使用できます。
• すべての locale パラメータ（locales[<language_code>][...]）は、任意の ISO 639 言語コードを使用できます。複数の言語の locale パラメータを一度に指定できますが、デフォルトとして設定できるのは 1 つのみです。

パラメータ	タイプ	必須	説明
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"