メインコンテンツまでスキップ

アプリ内商品の追加

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

エンドポイント

メソッドURL
POSThttps://ws.catappult.io/api/applications/{applicationName}/consumables

認証

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

⚠️
必要なアカウントの種類

アプリ内商品は、Developer タイプのアカウントでのみ作成できます。

ヘッダー

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

パスパラメータ

パラメータ説明
applicationNamestringアプリ内商品が作成されるアプリケーションを識別します。(例: 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 つだけです。
パラメータ必須説明
skustring必須アプリ内商品の一意の識別子 (例: product01)。
referencePriceCurrencystring必須参照価格の ISO 4217 通貨コード。利用可能な通貨コードを参照してください。
referencePriceAmountstring必須参照価格の数値。
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 USD、ポルトガル (PT) の国別価格は 2 EUR に設定され、スペイン語 (es) とポルトガル語 (pt) のローカライズされたコンテンツを含みます (cURL):

curl -X POST "https://ws.catappult.io/api/applications/com.example.app/consumables?operatingSystem=android" \
-H "Api-Key: YOUR_API_KEY" \
-F "sku=product01" \
-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"