(Alpha) The Bidco Android SDK makes it easy to add purchasing, engagement, user authentication and other Bidco features to Android apps.

Topics


The Android SDK is currently a alpha release; its content and functionality are likely to change significantly and without warning. Note that by using Bidco developer tools, you accept our Developer Terms of Use.

About the Android SDK

The Bidco SDK for Android is the easiest way to integrate your Android app with Bidco to enable:

  • Easily paying for items while shopping in-store, online and on a mobile.
  • Securely storing payment details to enable one-tap purchases.
  • Scan, touch or listen to Bidco tags to enter competitions, receive offers, browse store catalogues and much more.
  • Multi item baskets that can easily be managed by user of the app.
  • Discover offers and promotions which are relevant and interesting to you based upon location and previous purchases.

Registering Your Application

When registering your application you will recieve the credentials (API key and secret) needed to initialise the SDK and start using Bidco features.

You can register here

Downloading the SDK

The Android SDK is available for download from its home on GitHub:


Installing The SDK

Requirements

Bidco SDK for Android requires a minimum Android API level of 9, ensure either your AndroidManifest.xml has android:minSdkVersion="9" or your /app/build.gradle file has minSdkVersion 9 or higher.


Install the SDK using Android Studio

To use Bidco SDK in a project, add it as a build dependency and import it.

  1. Add the following to Module-level build.gradle before dependencies:
repositories {
	maven { url "http://nexus.ht.powa.com/nexus/content/repositories/ptk-releases/" }
}
  1. Modify the build.gradle file:

Add the compile dependency with the latest version of the Bidco SDK

dependencies {
	compile 'com.powatag.android:powatag-kit:{{site.current_sdk_version}}'
}

Add exclusions to the packagingOptions

packagingOptions {
	exclude 'META-INF/LICENSE'
	exclude 'META-INF/LICENSE.txt'
	exclude 'META-INF/NOTICE'
	exclude 'META-INF/NOTICE.txt'
}

3. Press the Sync Now notification at the top of the code window, or manually refresh Gradle if you are not prompted.
  1. Build your project. Now you can import com.powatag.android.sdk.PowaTagKit into your app.

Install the SDK Manually

  1. Extract the SDK Zip folder.

  1. Go to File > New Module > "Import .JAR or .AAR Package" and add the powatag-kit.aar file located in the library folder.

  1. Set powatag-kit-{{site.current_sdk_version}} as a new dependency of your application module by going to File > Project Structure. On tab Dependencies tab click plus button and choose powatag-kit-{{site.current_sdk_version}} module.

  1. Now you can import com.powatag.android.sdk.PowaTagKit into your app.

Using the Bidco SDK with Maven

You can declare the Maven dependency with the latest available version of the Android SDK:

<dependency>
	<groupId>com.powatag.android</groupId>
	<artifactId>powatag-kit</artifactId>
	 <version>{{site.current_sdk_version}}</version>
</dependency>

Initialize the SDK

You need to initialize Bidco SDK before you can use it. Please use the API key and secret that was provided to you during registration. Add a call to PowaTagKit.initializeSdk from onCreate in Application or Activity using:

@Override
public void onCreate(Bundle savedInstanceState) {
	super.onCreate(savedInstanceState);
	//Initialize the SDK using the default Bidco endpoint
	PowaTagKit.initializeSdk(getApplicationContext(), apiKey, secret);
}

During development you need to use a non-production endpoint and for this a second initialization method is available:

@Override
public void onCreate(Bundle savedInstanceState) {
	super.onCreate(savedInstanceState);
	PowaTagEndpoint endpoint = PowaTagEndpoint.defaultEndpointPorts(hostNameString);
	PowaTagKit.initializeSdk(getApplicationContext(), endpoint, apiKey, secret);
}

Importing The Sample App

The HelloPowaTagSample app is included with the SDK to provide you with examples of the main Bidco SDK features.

You can experiment with the SDK features by importing the app into Android Studio project (steps may differ in other IDEs):

  1. Go to Android Studio | New | Import Project

  1. Navigate to the folder where you unpacked the SDK, open the samples folder, and choose the hellopowatag-sample project to import. Click OK to open it.

import image 2


  1. Build the sample project.

The sample has a project dependency rather than a central repository dependency via Maven Central or jcenter. This is so that when a local copy of the SDK gets updates, the sample reflects the changes.


API Documentation

The download package includes comprehensive documentation of all API classes. Because Android libraries cannot include Javadoc files, HTML documentation is shipped within the download zipfile. You can also read the documentation online.


Next Steps

After you install Bidco SDK for Android, you can see review the following sections:

  • Authentication - securely authenticate users to access their Bidco profile.
  • User Profiles - manage all the personal, address and payment details of the user.
  • Triggers - enable the detection of Bidco tags to trigger workflows
  • Workflows - enable the different workflows
  • Products - retrieve and manage products and product variants that merchants are selling.
  • Coupons - manage coupons the user's coupons and redeem them during purchases.
  • Baskets - manage baskets for different merchants.
  • Catalogs - retrieve merchant catalogs in app and select products for purchase.
  • Payments - easily process payments for the user's orders.
  • Acts - enable users to enter competitions, request information or respond to a 'call to action'.

Terms of Use

The Android SDK is currently a beta release; its content and functionality are likely to change significantly and without warning. Note that by using Spotify developer tools, you accept our Developer Terms of Use.