kudosKit for iOS - Instructions (v1.6)

1. Overview

This document explains how to start using kudosKit in your iOS applications.

kudosKit - iOS SDK

kudosKit - Main Site

kudosKit - Developer Console

2. Add Your Application

  • Sign up with kudosKit
  • After login click on "Add Application" on the left sidebar and add your app by typing the bundle identifer (com.mycompany.myapp) or package name
  • After adding your app you will see your app key on the right side of the app overview page

3. Add In-App Purchases

In order to use appreciation modules that collect money you will need to setup four consumable in-app product IDs (Tier 1-4) in iTunes Connect - this is used by the server to optimize and find which prices work best.

Product IDTitleDescriptionDefault Price
com.yourapp.kudos1Kind developer contributionSupport usTier 1
com.yourapp.kudos2Helpful developer contributionSupport usTier 2
com.yourapp.kudos3Generous developer contributionSupport usTier 3
com.yourapp.kudos4Super generous developer contributionSupport usTier 4

When you're done it should look like this:

./img/inapps.png

4. Set up SDK

  • In your xcode project, select the Project Navigator view
  • Open Finder and navigate to where you extracted the SDK to
  • Drag the KudosKit.framework you just extracted into your project's Framework group in xcode
  • Make sure ‘add to targets’ has your project selected
  • Also check that ‘Copy items into destination group’s folder (if needed)’ is selected

5. Frameworks

In xcode select your target -> build phases -> link binaries with libraries and add the following frameworks:

StoreKit.framework
AudioToolbox.framework
CFNetwork.framework
AdSupport.framework
Social.framework
MessageUI.framework
libz.dylib

Make sure KudosKit.framework is already in the list. If not, drag the framework from the project on the left into that list.

If deploying to iOS < 6.0, you should make the AdSupport and Social frameworks 'optional' rather than 'required'.

In the build settings ‘Other linker Flags’ you should add -ObjC . You are ready for some coding (not much :).

6. Basic SDK initialization

At the top of your app delegate file add the following line:

#import "KudosKit/KudosKit.h"

At the bottom of your didFinishLaunchingWithOptions, just before returning add the setup function:

-(BOOL) application:(UIApplication *)application
didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  ...
  [[KudosKit instance] setupWithKey:@"YOURAPPKEY"
                           features:nil
                             inApps:[NSArray arrayWithObjects:
                                             @"com.yourapp.kudos1",
                                             @"com.yourapp.kudos2",
                                             @"com.yourapp.kudos3",
                                             @"com.yourapp.kudos4", nil]];
  return YES;
}

YOURAPPKEY is the application key generated for you in the development console when adding your application.

features should remain nil for now.

inApps is the set of inapps you created in iTunes Connect.

7. Test SDK

In order to make sure everything is set up properly, place this method to launch the debug screen which will report the status of the SDK:

[[KudosKit instance] debug];

8. Set the rightspots

A rightspot is where you call the kudosKit server in order to display the appreciation module if the user is ready. It should be placed for example in the end of a level, when a user finishes a flow or at the main screen.

The call looks like this:

[[KudosKit instance] startRightSpot:@"level completed" completion:^{} force:NO];

At the developer console you assign which appreciation modules to display at each rightspot.

9. Assign an appreciation module

  • At the developer console, on the app overview page, a default appreciation module is set.
  • Click on "Add a new module" will open the gallery of avaliable modules.
  • After adding one, assign it to the desired rightspots.

Now go back to develop your app and let kudosKit do the rest.

Date: 2014-08-21T17:53+0300

Author: IronSource

Org version 7.9.3f with Emacs version 24

Validate XHTML 1.0