Documentation

Collapse

AppA Integration Guide

Adding AppA services to your app is simple: Sign up for an AppA account, add your app to the system and integrate the service library with your app's existing code.

Step 1: Create An AppA Account

Create your AppA account by visiting the official AppA HQ web site and entering your basic information into the sign-up form.

Along with your name and email address, you will be asked to provide an Tapestry ID. This is a unique login used to access Tapestry services, including AppA. You will need this account in order to log in and make changes to your AppA implementation (If you already have a Tapestry ID, please log in before continuing so that you may skip this step).

Upon providing your information, you'll be asked to pick an AppA plan that best fits your needs. A free AppA Basic plan is available that allows the addition of up to 3 apps. However, you may choose a plan that provides support for a greater number of apps to support your business for a nominal monthly fee.

Once your account is created, you will be able to proceed to the next step. However, at this point you should visit the Settings section and make note of the Access Code assigned to you. This will be used when you integrate AppA into your app.

Step 2: Add Your App

Once you have created your AppA account, you must add any apps you plan to use with the service. To do so, visit the App Adder and enter the Apple ID associated with your app.

If you do not know your app's Apple ID, you may obtain this from within iTunes Connect.

Photo from iTunes Connect
App-specific Apple ID, viewable in iTunes Connect

Once added, your app will be entered into the AppA system and you will be taken to the App Editor. At this point you may customize any settings you'd like, though doing so is unnecessary. Make note of your Apple ID, though, as you will need it when you integrate AppA into your app's source code.

Step 3: Integrate AppA Into Your App

In order to integrate AppA into your app, you will need the following:

  • Your AppA account's Access Code
  • Your app's Apple ID

(Review the steps above if you do not have this information)

Launch Xcode and open your project (for the purposes of this document, the use of Xcode 4 is assumed).

Download the AppA Library and decompress it. From the Finder, drag the folder named 'AppA - iOS' into your project's classes. You may store the folder in a centralized location (for use with multiple projects) or copy it into your project directly.

Photo from iTunes Connect

Next, you will need to add the QuartzCore framework to your project. In the Project navigator, select your target and click on the Build Phases section. Expand the Link Binary With Libraries group and press the "+" button to add a library.

Photo from iTunes Connect

A list of libraries and frameworks will appear. Select "QuartzCore.framework" and click Add.

Photo from iTunes Connect

Once you've completed the above tasks, you will need to decide how to display AppA within your app. Typically, this is done from an 'About' button or something similar within an app's user interface. Assuming that you use Interface Builder and initiate display as an IBAction, you could use the following few lines of Objective C source code to display AppA:

- (IBAction) DisplayAppA: (id) sender { // STEP 1: Init AppA AppA *myAppA = [[AppA alloc] init]; // STEP 2: Supply Access Code and app's Apple ID myAppA.appaAccessCode = @"asdf1234"; myAppA.appaAppID = @"12345678"; // STEP 3: Present modal and release AppA [self presentModalViewController:myAppA animated:TRUE]; [myAppA release]; }

That's all it takes! The above code will display basic AppA services (AppAbout, AppAssist and AppAware) within your app. You may configure these services individually via the AppA web site.

You may, however, modify the way in which AppA is displayed. You may opt to only utilize certain services, for instance, or provide a custom background using your own code. You can learn more in the AppA Integration Reference.




Copyright © 2011 Tapestry • All rights reserved