Install and Configure App Tester

With App Tester you can unit test the In-App Purchasing (IAP) functionality of your app in sandbox mode before you submit the app for publication. You download App Tester onto the same device as your app, or use the Vega Virtual Device (VVD). The App Tester simulates the production environment. When you run IAP-related test cases on your app, and App Tester generates API responses that you configure using a JSON file.

App Tester prerequisites

Your development and testing environment must meet the following prerequisites to run test cases with App Tester:

Your development environment allows logging using VDA and logcat. Here are more details about how to Connect using VDA, as well as the VDA commands.
Your app implements the Vega IAP API method calls.
You have no SDK Tester on the device. SDK Tester is not compatible with App Tester or with the Vega IAP SDK.
You have added the following information to the manifest.toml file.

[wants]
# ... other wants

[[wants.service]]
id = "com.amazon.iap.tester.service" # This is required for tester (Sandbox mode)

[[wants.module]]
id = "/com.amazonappstore.iap.tester@IIAPTesterUI"

[needs]

[[needs.module]]
id = "/com.amazon.kepler.appstore.iap.purchase.core@IAppstoreIAPPurchaseCoreService"

# ...

You should create one or more purchasable items for your app in the Amazon Appstore. Once you have a purchasable item, you can create the required JSON file.

Download App Tester

The App Tester is a free app. Download the app and view the installation instructions on this page.

For React Native 0.72

Here’s how you set it up on your device:

Archived Customer Choice Billing downloads

Install App Tester on your device

Here’s how you set it up on your device:

To install and launch the IAP App Tester, follow the instructions on how to Run your app on Vega Virtual Device or Fire TV Stick.

Here’s a quick reference.

Installing on a Fire TV device

To push .vpkg file

kepler exec vda push <path to .vpkg file>/<appname.vpkg> /tmp

To access your Fire TV

kepler exec vda shell

To install App Tester on your device

vpm install /tmp/<appname.vpkg>

To access your Fire TV

kepler exec vda shell

To uninstall App Tester on your device

vpm uninstall <package_id>

Installing on a Vega Virtual Device

To start VVD

kepler virtual-device start

To install the app on VVD

kepler run-kepler  <path to .vpkg file>/<appname.vpkg> com.amazonappstore.iap.tester.ui -d VirtualDevice

To access VVD

kepler exec vda shell

To launch App Tester on your device

vlcm launch-app pkg://com.amazonappstore.iap.tester.ui

To terminate App Tester on your device

vlcm terminate-app -f -p com.amazonappstore.iap.tester

Learn more about vpm and vlcm in our Package and Lifecycle Manager documentation. To install and run your app on VVD, see Install and Configure App Tester.

Create a JSON data file

The App Tester responds to API calls using data stored in a JavaScript Object Notation (JSON) file. The file contains purchase data for the IAP items. Automatically create the JSON file through the Apps & Games Developer Portal.

Go to your app’s page on the Apps & Games Developer Portal in a web browser.
Add your IAP purchasable items to your app, if you haven’t already done so.
Click the link to download your JSON Data File.
Name the downloaded file amazon.sdktester.json.

Push the SKU JSON file into the device. 1. To create a directory on the device

kepler exec vda shell mkdir /tmp/scratch/com.amazonappstore.iap.tester/

2. To push to a created directory

kepler exec vda push <amazon.sdktester.json file> /tmp/

kepler exec vda shell cp /tmp/<amazon.sdktester.json> /tmp/scratch/com.amazonappstore.iap.tester/

To create a JSON data file for VVD

1. To create this directory on the device

kepler exec vda shell mkdir /tmp/scratch/com.amazonappstore.iap.tester/

2. To push to the created directory

kepler device copy-to -s <path of amazon.sdktester.json> --destination /tmp/scratch/com.amazonappstore.iap.tester

If you open the downloaded JSON file, the file format looks like the following.

{
 Item_ID_1:{Item_1_Description},
 Item_ID_2:{Item_2_Description},
 .
 .
 .
 Item_ID_n:{Item_n_Description}
 }

The actual item description definition varies by item type. The order of the items in the JSON file is not significant. Notice the comma ”,” between description definitions.

File format and example: IAP consumable and entitlement items

Consumable and Entitlement IAP Item Descriptions have the same format. The itemType property indicates whether the item is ENTITLED or CONSUMABLE. Every purchasable item is associated with a unique identifier called an SKU.

"your_item_SKU":{
  "itemType": "ENTITLED|CONSUMABLE",
  "price": price,
  "title": "item_title",
  "description": "item_description",
  "smallIconUrl": "full_url_for_small_icon"
  }

The following example shows a consumable and an entitlement item:

{
"com.amazon.sample.iap.consumables.orange":{
  "itemType": "CONSUMABLE",
  "price": 10.00,
  "title": "Orange",
  "description": "An orange",
  "smallIconUrl": "http://www.amazon.com/orange.jpg"
  },

"com.amazon.sample.iap.entitlements.level2":{
  "itemType": "ENTITLED",
  "price": 10.00,
  "title": "Level 2",
  "description": "An entitlement to play level 2"
  }
}

File format and example: IAP subscription item

Subscription items are different from other types of items you purchase. Every purchasable item is associated with an identifier called an SKU that identifies it as unique. When a subscriber purchases an item, the system uses two SKUs. The “parent SKU” describes what the subscription is for (such as a magazine title). The other SKU is the “terms SKU,” which describes the terms (price, length) of the subscription. The terms SKU is what actually gets purchased by a customer. Since the terms SKU is the purchasable item, the JSON IAP Item Description is for that item. However, the description must also contain a reference to the Parent SKU. Therefore, subscription item types include an additional property: subscriptionParent.

"your_terms_SKU":{
  "itemType": "SUBSCRIPTION",
  "price": price,
  "title": item_title,
  "description": item_description,
  "smallIconUrl": "http://www.amazon.com/kindle.jpg",
  "subscriptionParent": "your_parent_SKU"
  }

The the following example of a subscription item description. Notice the subscription parent SKU.

{
  "com.amazon.sample.iap.subscription.mymagazine.silver": {
      "description": "Monthly Subscription to My Magazine Silver",
      "title": "Silver month",
      "itemType": "SUBSCRIPTION",
      "price": 50.0,
      "subscriptionBase": "com.amazon.subs.base",
      "subscriptionParent": "com.amazon.subs.silver",
      "term": "Monthly",
      "freeTrialPeriod": "Monthly",
  },
  "com.amazon.sample.iap.subscription.mymagazine.gold": {
      "description": "Monthly Subscription to My Magazine Gold",
      "title": "Gold month",
      "itemType": "SUBSCRIPTION",
      "price": 80.0,
      "term": "Monthly",
      "subscriptionBase": "com.amazon.subs.base",
      "subscriptionParent": "com.amazon.subs.gold"
  }
}

Verify your IAP items

To review the contents of the JSON file, go to the App Tester main menu. Then tap the IAP Items in JSON File option to display a human-readable list of the item data in the JSON file. Next step: Use App Tester

​App Tester prerequisites

​Download App Tester

​For React Native 0.72

​Archived Customer Choice Billing downloads

​Install App Tester on your device

​Installing on a Fire TV device

​Installing on a Vega Virtual Device

​Create a JSON data file

​To create a JSON data file for VVD

​File format and example: IAP consumable and entitlement items

​File format and example: IAP subscription item

​Verify your IAP items