Download the latest version with source code from this Git repository https://github.com/BranchMetrics/Branch-AIR-ANE-SDK/archive/master.zip you can also clone it.

Import the Branch.ane into your project. Depending your IDE you might need to import the Branch.swc as well.
Inside your *-app.xml be sure to add this line <extensionID>io.branch.nativeExtensions.Branch</extensionID>

You can sign up for your own app id at https://dashboard.branch.io

Inside the *-app.xml you must add your Branch App Key (refer to the dashboard to get it).

<iPhone><InfoAdditions><![CDATA[
	<!-- other stuff -->
	<key>branch_key</key>
	<string>key_live_xxxx</string>
]]></InfoAdditions></iPhone>

For a full example of the *-app.xml please refer to the demo.

Inside the *-app.xml you must add your Branch App Key (refer to the dashboard to get it). And also don't forget to set the Branch activity:

<android><manifestAdditions><![CDATA[
	<!-- other stuff -->
	<application>
		<meta-data android:name="io.branch.sdk.BranchKey" android:value="key_live_xxxxx" />
		<meta-data android:name="io.branch.sdk.BranchKey.test" android:value="key_test_yyyyyyy" />
		<meta-data android:name="io.branch.sdk.TestMode" android:value="false" />
		<activity android:name="io.branch.nativeExtensions.branch.BranchActivity" android:launchMode="singleTask" android:theme="@android:style/Theme.Translucent.NoTitleBar.Fullscreen" />
	</application>
]]></manifestAdditions></android>

For a full example of the *-app.xml please refer to the demo.

Ideally, you want to use our links any time you have an external link pointing to your app (share, invite, referral, etc) because:

1. Our dashboard can tell you where your installs are coming from
2. Our links are the highest possible converting channel to new downloads and users
3. You can pass that shared data across install to give new users a custom welcome or show them the content they expect to see

Our linking infrastructure will support anything you want to build. If it doesn't, we'll fix it so that it does: just reach out to [email protected] with requests.

In your project's *-app.xml file, you can register your app to respond to direct deep links (yourapp:// in a mobile browser) by adding a URI scheme. Also, make sure to change yourApp to a unique string that represents your app name.
On iOS:

<key>CFBundleURLTypes</key>
<array>
	<dict>
		<key>CFBundleURLSchemes</key>
		<array>
			<string>yourApp</string>
		</array>
	</dict>
</array>

On Android:

<activity>
	<intent-filter>
		<data android:scheme="yourApp" />
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
    </intent-filter>
</activity>

For a full example of the *-app.xml please refer to the demo.

For a full example refer to the demo as3 file.

Inside your Main.as make the following import:

import io.branch.nativeExtensions.branch.Branch;
import io.branch.nativeExtensions.branch.BranchEvent;

Then create a Branch instance:
var branch:Branch = new Branch();
Note that Branch is a Singleton, it can only have one instance which can also be used thanks to a static:
Branch.getInstance();

Then you can register two events before initializing the SDK:

branch.addEventListener(BranchEvent.INIT_FAILED, initFailed);
branch.addEventListener(BranchEvent.INIT_SUCCESSED, initSuccessed);

private function initFailed(bEvt:BranchEvent):void {
	trace("BranchEvent.INIT_FAILED", bEvt.informations);
}

private function initSuccessed(bEvt:BranchEvent):void {
	trace("BranchEvent.INIT_SUCCESSED", bEvt.informations);
	
	// params are the deep linked params associated with the link that the user clicked before showing up
	// params will be empty if no data found
	var referringParams:Object = JSON.parse(bEvt.informations);
	
	//trace(referringParams.user);
}

Once is done, initialize the SDK: branch.init();
Be sure to have the INIT_SUCCESSED event called, otherwise read the bEvt.informations from the INIT_FAILED event.

These session parameters will be available at any point later on with this command. If no params, the dictionary will be empty. This refreshes with every new session (app installs AND app opens).

var sessionParams:String = branch.getLatestReferringParams();
var sessionParamsObj:Object = JSON.parse(sessionParams);

If you ever want to access the original session params (the parameters passed in for the first install event only), you can use this line. This is useful if you only want to reward users who newly installed the app from a referral link or something.

var installParams:String = branch.getFirstReferringParams();
var installParamsObj:Object = JSON.parse(installParams);

Often, you might have your own user IDs, or want referral and event data to persist across platforms or uninstall/reinstall. It's helpful if you know your users access your service from different devices. This where we introduce the concept of an 'identity'.

To identify a user, just call:branch.setIdentity("your user id");

If you provide a logout function in your app, be sure to clear the user when the logout completes. This will ensure that all the stored parameters get cleared and all events are properly attributed to the right identity.

Warning this call will clear the referral credits and attribution on the device.
branch.logout();

On Android only, clear the deep link parameters when the app is closed, so they can be refreshed after a new link is clicked or the app is reopened. This is automatically done by the ANE AS3 code using Event.DEACTIVATE and Event.ACTIVATE.

There are a bunch of options for creating these links. You can tag them for analytics in the dashboard, or you can even pass data to the new installs or opens that come from the link click. How awesome is that? You need to pass a callback for when your link is prepared (which should return very quickly, ~ 50 ms to process).

For more details on how to create links, see the Branch link creation guide.

//be sure to add the event listeners:
branch.addEventListener(BranchEvent.GET_SHORT_URL_FAILED, getShortUrlFailed);
branch.addEventListener(BranchEvent.GET_SHORT_URL_SUCCESSED, getShortUrlSuccessed);

private function getShortUrlSuccessed(bEvt:BranchEvent):void {
	trace("BranchEvent.GET_SHORT_URL_SUCCESSED", "my short url is: " + bEvt.informations);
}

private function getShortUrlFailed(bEvt:BranchEvent):void {
	trace("BranchEvent.GET_SHORT_URL_FAILED", bEvt.informations);
}

var dataToInclude:Object = {
	user:"Joe",
	profile_pic:"https://avatars3.githubusercontent.com/u/7772941?v=3&s=200",
	description:"Joe likes long walks on the beach...",
	
	// customize the display of the Branch link
	"$og_title":"Joe's My App Referral",
	"$og_image_url":"https://branch.io/img/logo_white.png",
	"$og_description":"Join Joe in My App - it's awesome"
};

var tags:Array = ["version1", "trial6"];

branch.getShortUrl(tags, "text_message", BranchConst.FEATURE_TAG_SHARE, "level_3", JSON.stringify(dataToInclude));

There are other methods which exclude tag and data if you don't want to pass those.

Note You can customize the Facebook OG tags of each URL if you want to dynamically share content by using the following optional keys in the data dictionary:

Also, you do custom redirection by inserting the following optional keys in the dictionary:

You have the ability to control the direct deep linking of each link by inserting the following optional keys in the dictionary:

In a standard referral system, you have 2 parties: the original user and the invitee. Our system is flexible enough to handle rewards for all users. Here are a couple example scenarios:

1. Reward the original user for taking action (eg. inviting, purchasing, etc)

2. Reward the invitee for installing the app from the original user's referral link

3. Reward the original user when the invitee takes action (eg. give the original user credit when their the invitee buys something)

These reward definitions are created on the dashboard, under the 'Reward Rules' section in the 'Referrals' tab on the dashboard.

Warning: For a referral program, you should not use unique awards for custom events and redeem pre-identify call. This can allow users to cheat the system.

Reward balances change randomly on the backend when certain actions are taken (defined by your rules), so you'll need to make an asynchronous call to retrieve the balance. Here is the syntax:

branch.addEventListener(GET_CREDITS_SUCCESSED, getCreditsEvent);
branch.addEventListener(GET_CREDITS_FAILED, getCreditsEvent);

function getCreditsEvent(bEvt:BranchEvent):void {
	
	trace(bEvt.informations);
}

branch.getCredits();

We will store how many of the rewards have been deployed so that you don't have to track it on your end. In order to save that you gave the credits to the user, you can call redeem. Redemptions will reduce the balance of outstanding credits permanently.

branch.redeemRewards(5);

This call will retrieve the entire history of credits and redemptions from the individual user. To use this call, implement like so:

branch.addEventListener(GET_CREDITS_HISTORY_SUCCESSED, getCreditsHistoryEvent);
branch.addEventListener(GET_CREDITS_HISTORY_FAILED, getCreditsHistoryEvent);

function getCreditsHistoryEvent(bEvt:BranchEvent):void {
	
	trace(bEvt.informations);
}

branch.getCreditsHistory();

The response will return an array that has been parsed from the following JSON:

[
    {
        "transaction": {
                           "date": "2014-10-14T01:54:40.425Z",
                           "id": "50388077461373184",
                           "bucket": "default",
                           "type": 0,
                           "amount": 5
                       },
        "event" : {
            "name": "event name",
            "metadata": { your event metadata if present }
        },
        "referrer": "12345678",
        "referree": null
    },
    {
        "transaction": {
                           "date": "2014-10-14T01:55:09.474Z",
                           "id": "50388199301710081",
                           "bucket": "default",
                           "type": 2,
                           "amount": -3
                       },
        "event" : {
            "name": "event name",
            "metadata": { your event metadata if present }
        },
        "referrer": null,
        "referree": "12345678"
    }
]

referrer : The id of the referring user for this credit transaction. Returns null if no referrer is involved. Note this id is the user id in developer's own system that's previously passed to Branch's identify user API call.

referree : The id of the user who was referred for this credit transaction. Returns null if no referree is involved. Note this id is the user id in developer's own system that's previously passed to Branch's identify user API call.

type : This is the type of credit transaction

1. 0 - A reward that was added automatically by the user completing an action or referral
2. 1 - A reward that was added manually
3. 2 - A redemption of credits that occurred through our API or SDKs
4. 3 - This is a very unique case where we will subtract credits automatically when we detect fraud

Retrieve the referral code created by current user

branch.addEventListener(GET_REFERRAL_CODE_SUCCESSED, getReferralCodeEvent);
branch.addEventListener(GET_REFERRAL_CODE_FAILED, getReferralCodeEvent);

function getReferralCodeEvent(bEvt:BranchEvent):void {
	
	trace(bEvt.informations); // stringified JSON
}

branch.getReferralCode();

Create a new referral code for the current user, only if this user doesn't have any existing non-expired referral code.

In the simplest form, just specify an amount for the referral code. The returned referral code is a 6 character long unique alpha-numeric string wrapped inside the params dictionary with key @"referral_code".

amount int : The amount of credit to redeem when user applies the referral code

// Create a referral code of 5 credits
branch.addEventListener(CREATE_REFERRAL_CODE_SUCCESSED, createReferralCodeEvent);
branch.addEventListener(CREATE_REFERRAL_CODE_FAILED, createReferralCodeEvent);

function createReferralCodeEvent(bEvt:BranchEvent):void {
	
	trace(bEvt.informations); // stringified JSON
}

branch.createReferralCode("", 5);

Alternatively, you can specify a prefix for the referral code. The resulting code will have your prefix, concatenated with a 2 character long unique alpha-numeric string wrapped in the same data structure.

prefix String : The prefix to the referral code that you desire

branch.addEventListener(CREATE_REFERRAL_CODE_SUCCESSED, createReferralCodeEvent);
branch.addEventListener(CREATE_REFERRAL_CODE_FAILED, createReferralCodeEvent);

function createReferralCodeEvent(bEvt:BranchEvent):void {
	
	trace(bEvt.informations); // stringified JSON
}

branch.createReferralCode("BRANCH", 5); // prefix should not exceed 48 characters

If you want to specify an expiration date for the referral code, you can add an expiration parameter. The prefix parameter is optional here, i.e. it could be getReferralCode(5, expirationDate, new BranchReferralInitListener()...

expiration Date : The expiration date of the referral code

branch.addEventListener(CREATE_REFERRAL_CODE_SUCCESSED, createReferralCodeEvent);
branch.addEventListener(CREATE_REFERRAL_CODE_FAILED, createReferralCodeEvent);

function createReferralCodeEvent(bEvt:BranchEvent):void {
	
	trace(bEvt.informations); // stringified JSON
}

branch.createReferralCode("BRANCH", 5, expirationDate); // prefix should not exceed 48 characters

You can also tune the referral code to the finest granularity, with the following additional parameters:

bucket String (max 63 characters) : The name of the bucket to use. If none is specified, defaults to 'default'

calculation_type int : This defines whether the referral code can be applied indefinitely, or only once per user

1. REFERRAL_CODE_AWARD_UNLIMITED - referral code can be applied continually
2. REFERRAL_CODE_AWARD_UNIQUE - a user can only apply a specific referral code once

location int : The user to reward for applying the referral code

1. REFERRAL_CODE_LOCATION_REFERREE - the user applying the referral code receives credit
2. REFERRAL_CODE_LOCATION_REFERRING_USER - the user who created the referral code receives credit
3. REFERRAL_CODE_LOCATION_BOTH - both the creator and applicant receive credit

branch.addEventListener(CREATE_REFERRAL_CODE_SUCCESSED, createReferralCodeEvent);
branch.addEventListener(CREATE_REFERRAL_CODE_FAILED, createReferralCodeEvent);

function createReferralCodeEvent(bEvt:BranchEvent):void {
	
	trace(bEvt.informations); // stringified JSON
}

branch.createReferralCode("BRANCH", 5, expirationDate, "default", BranchConst.REFERRAL_CODE_AWARD_UNLIMITED, BranchConst.REFERRAL_CODE_LOCATION_REFERRING_USER);

Validate if a referral code exists in Branch system and is still valid. A code is vaild if:

1. It hasn't expired.
2. If its calculation type is uniqe, it hasn't been applied by current user.

If valid, returns the referral code JSONObject in the call back.

code String : The referral code to validate

branch.addEventListener(VALIDATE_REFERRAL_CODE_SUCCESSED, validateReferralCodeEvent);
branch.addEventListener(VALIDATE_REFERRAL_CODE_FAILED, validateReferralCodeEvent);

function validateReferralCodeEvent(bEvt:BranchEvent):void {
	
	trace(bEvt.informations); // stringified JSON
}

branch.validateReferralCode(code);

Apply a referral code if it exists in Branch system and is still valid (see above). If the code is valid, returns the referral code JSONObject in the call back.

code String : The referral code to apply

branch.addEventListener(APPLY_REFERRAL_CODE_SUCCESSED, applyReferralCodeEvent);
branch.addEventListener(APPLY_REFERRAL_CODE_FAILED, applyReferralCodeEvent);

function applyReferralCodeEvent(bEvt:BranchEvent):void {
	
	trace(bEvt.informations); // stringified JSON
}

branch.applyReferralCode(code);

To compile this ANE, you need to have ANT installed on your (OS X) machine, and Java 1.6.
Clone the repository, and change the build.config to match your computer settings with the path to your AIR SDK (you should have the latest one), to the Android SDK, and to a keystore (a certificate for Air, which may be a self-signed certificate created with adt).
Finally open a command line, cd in the directory and just call ant.