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

Topics


The iOS 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 iOS SDK

The Bidco SDK for iOS is the easiest way to integrate your iOS 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 iOS SDK is available for download from its home on GitHub:


Installing The SDK

Requirements

Bidco SDK for iOS requires a minimum iOS version of 7.


Install the SDK with CocoaPods

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

  1. Create a file called "Podfile" at the root of your project, if you don't already have one.

  1. If the file is empty, you will need to include at least the version of iOS you are supporting. You may also need to include your workspace name. See the following link for more info on working with CocoaPods: http://guides.cocoapods.org/using/using-cocoapods.html.

new podfile


  1. Add the PowaTag SDK dependency to the Podfile:
pod 'PowaTagKit'

start podfile

  1. Save your changes, and then open a terminal window. Enter the following command:
pod install

  1. Build your project. Now you can import PowaTagKit.h into your project.

  1. 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 and copy the PowaTagKit.framework into your Xcode project.

  1. Build your project. Now you can import PowaTagKit.h into your app.

Initialize the SDK

You need to initialize PowaTag SDK before you can use it. Please use the API key and secret that was provided to you during registration.

Add a call to [PowaTagSDK initializeSdkWithApiKey] from application:didFinishLaunchingWithOptions: in UIApplicationDelegate or viewDidLoad in UIViewController:

- (void)viewDidLoad {
	[PowaTagKit initializeSdkWithApiKey:@“apiKey”
	secret:@“secret”];
}

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

- (BOOL)application:(UIApplication *)application
didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
	[PowaTagKit initializeSdkWithEndpoint:[PowaTagEndpoint defaultEndpoint]
	apiKey:@“apiKey”
	secret:@“secret”];
}

Importing The Sample App

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

You can experiment with the SDK features by importing the app into Xcode.

  1. Go to Xcode | File | Open

  1. Navigate to the folder where you unpacked the SDK, open the Samples folder, and choose the HelloPowaTagSample project. Click OK to open it.

  1. Build the sample project.

The sample has a project dependency rather than a central repository dependency via CocoaPods. This is so that when a local copy of the SDK gets updates, the samples reflect 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.