Skip to content

Latest commit

 

History

History
187 lines (131 loc) · 7.35 KB

README_EN.md

File metadata and controls

187 lines (131 loc) · 7.35 KB

RuStore SDK Billing implementation example

SDK Billing documentation

Table of contents

Prerequisites

For in-app payments to work, the following requirements must be met.

  1. The RuStore app must be installed on the user's device.

  2. The user and the app are not banned in RuStore.

  3. In-app purchases for the app are enabled in RuStore Console.

The service has some restrictions to work outside of Russia.

Required parameters

To correctly configure the example app, you need to have the following parameters:

  1. consoleApplicationId - application code from RuStore Console (example: https://console.rustore.ru/apps/123456), in our example consoleApplicationId = 123456

  2. applicationId - value from the app you published in the RuStore Console, it is in the build.gradle of your project

     android {
    defaultConfig {
    applicationId = "ru.rustore.sdk.billingexample"
    }
 }

  3. availableProductIds - subscriptions and single purchases available in your app

  4. release.keystore - signature that was used to sign your app in the RuStore Console.

  5. release.properties - this file must contain the parameters of the signature that was used to sign your app published in the RuStore Console. Working with signature keys for APK files

Configure example app

To test your app, you can use our sandbox.

  1. Specify consoleApplicationId of your app in RuStoreBillingClientFactory.INSTANCE.create():

    private static RuStoreBillingClient ruStoreBillingClient = RuStoreBillingClientFactory.INSTANCE.create(
               app,
              "2063535084", // consoleApplicationId
              "ru.edudin.rustoreqrscanner", // deeplinkScheme
              null,
              null,
              true
       );

  2. Replace applicationId in build.gradle, with applicationId of the APK file that you published in the RuStore Console:

    android {
    defaultConfig {
       applicationId = "ru.rustore.sdk.billingexample"
    }
}

  3. In the cert folder replace the release.keystore certificate with the certificate of your app, also, in release.properties configure parameters key_alias, key_password, and store_password. The release.keystore signature must match the signature tha was used to sign the app published in the RuStore Console. Make sure that buildType used (example: debug) uses the same signature as the published app (example: release).

  4. In StartFragment of the getProducts method list subscriptions and consumable products available in your app:

    Arrays.asList(
   "productId1",
   "productId2",
   "productId3"
)

  5. Run your project and test your app performance

Use scenario

Payments availability check

On app start, in the onViewCreated method of StartFragment, payments availability is checked.

Retrieving products list

Pressing the 'getProducts()' button triggers retrieving and displaying the products list

Retrieve list of purchases

Pressing the 'getPurchases()' buttion triggers retrieving and displaying the purchases list

Product purchase

Pressing an item with a product name triggers the product purchase scenario with the payment method screen display. Then, if PaymentResult.Success -> is returned, purchase confirmation is triggered.

Deeplink handling

This section does not apply to the example app configuration. It contains the information on how to correctly configure deeplink in your app.

deeplinkScheme — a deeplink scheme required to return the user to your app after making a payment in a third-party app (for example: in SberPay or SBP). SDK generates its host for this scheme.

To redirect a user to your app after payment via third-party apps (the Faster Payments System (SBP), SberPay and others), you need to properly implement deep linking in your app. To achieve this, specify intent-filter with the scheme of your project in AndroidManifest.xml.

  1. In the data android:scheme parameter of your AndroidManifest.xml file specify the deeplink URL address (it must match deeplinkScheme from item 1)

    <activity
android:name=".MainActivity">

    <intent-filter>
       <action android:name="android.intent.action.VIEW" />
       <data android:scheme="rustoresdkexamplescheme" /> // Replace with your deeplink
    </intent-filter>

</activity>

  2. Specify deeplinkScheme of your app in RuStoreBillingClientFactory.INSTANCE.create:

     private static RuStoreBillingClient ruStoreBillingClient = RuStoreBillingClientFactory.INSTANCE.create(
                app,
                "184050",
                "rustoresdkexamplescheme",
                null,
                null,
                null,
                true
        );

  3. Next, add the following code to the Activity you need to return to after making the payment (your store page):

    public class MainActivity extends AppCompatActivity {

   private static final RuStoreBillingClient billingClient = YourDependencyInjection.provideRuStorebillingClient();

   public MainActivity() {
       super(R.layout.activity_main);
   }

   @Override
   protected void onCreate(Bundle savedInstanceState) {
       super.onCreate(savedInstanceState);
       if (savedInstanceState == null) {
         billingClient.onNewIntent(getIntent());
       }
   }

   @Override
   protected void onNewIntent(Intent intent) {
       super.onNewIntent(intent);
       billingClient.onNewIntent(intent);
   }
}

  4. To restore your app state after returning from deeplink, add android:launchMode="singleTask" to your AndroidManifest.xml

    <activity
   android:name=".MainActivity"
   android:launchMode="singleTask"
   android:exported="true"
   android:screenOrientation="portrait"
   android:windowSoftInputMode="adjustResize">

Distribution terms

This software, including its source code, binary libraries, and other files is distributed under the MIT license. The license information is available in the MIT-LICENSE.txt document

Technical support

If you have any questions regarding SDK Billing, please, follow this link.