bitly / bitly_ios_sdk_release

Bitly SDK for iOS

Bitly iOS SDK

Getting Started

Before integrating the SDK you will need to configure your mobile app in Bitly. To do this go to Brand Manager -> Mobile Apps. When creating the iOS app you will need to provide your Apple ID. The Apple ID is your team ID and bundle ID joined with a period (ex - 1A234H7ABC.com.yourdomain.YourApp). In the Apple’s Developer Portal your team ID appears on Organization Profile > Account Summary. When you enter the Member Center on http://developer.apple.com, click you name on the top right and click on “View Account” and you will find your team ID under the Developer Account Summary. If you choose to implement a Custom Scheme you may enter it at app creation time as well.

Once the app is created the app ID required later will be available on the app detail panel. Copy it for later in the setup.

To create the Apple Site Association File, which would be located at https://yourdomain.com/.well-known/apple-app-site-association, you must got to Branded Short Domains -> yourdomain.com -> Mobile Behavior and associate the newly created iOS App with your domain. After saving the changes you can validate the file exists.

Install the SDK

CocoaPods

1. Add the following to your Podfile

pod 'BitlySDK'

2. Run the following to download and install the SDK

pod install

Carthage

1. Add the following to your Cartfile

github "bitly/bitly_ios_sdk_release"

2. Run the following to download and build the framework

carthage update

3. Drag the built BitlySDK.framework into your Xcode project

Configure the Universal Links

1. In Xcode open your project file
2. Go to the Capabilities tab
3. Ensure that Associated Domains is enabled and expand it
4. Click on the + button and add your domain as applinks:yourdomain.com
5. Ensure that the yourprojectname.entitlements file is added to the appropriate build target

Configure the Custom Scheme

1. In Xcode open your Info.plist
2. Add a row for "URL types" as an array
3. Add an entry to that array as "URL Schemes" also as an array
4. Add a row with your custom scheme as the value

Custom Schemes are the older way of handling deep linking. However having an app that supports both Universal Links and Custom Schemes allows Bitly to work with Facebook App Links, Facebook Ads and other apps that launch content utilizing Custom Scheme deep links.

Configure the SDK for Deep Links

1. Import the SDK in your AppDelegate

Swift

import BitlySDK

Objective-C

#import <BitlySDK/BitlySDK.h>

2. Initialize the SDK on application initialization

Swift

func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
    Bitly.initialize("YOUR_APP_ID", supportedDomains:["yourdomain.com","yourotherdomain.com"], supportedSchemes:["yourscheme"]) { response, error in
        // response provides a BitlyResponse object which contains the full URL information
        // response includes a status code
        // error provides any errors in retrieving information about the URL
        // Your custom logic goes here...
    }
    return true
}

Objective-C

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [Bitly initialize:@"YOUR_APP_ID" supportedDomains:[NSArray arrayWithObjects: @"yourdomain.com", @"yourotherdomain.com", nil] supportedDomains:[NSArray arrayWithObjects: @"yourscheme", nil] handler:^(BitlyResponse * response, NSString * error) {
        // response provides a BitlyResponse object which contains the full URL information
        // response includes a status code
        // error provides any errors in retrieving information about the URL
        // Your custom logic goes here...
    }];
    return YES;
}

By default the Bitly SDK utilizes the IDFV to identify the user. If you which to use the IDFA to track the user simply provide the deviceId to the appropriate method when initializing the SDK. You can also provide the access token for shortening with the accessToken provided to the initializing methods.

3. Handle incoming links

Swift

func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([Any]?) -> Void) -> Bool {
    return Bitly.handle(userActivity)
}

func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey : Any] = [:]) -> Bool {
    return Bitly.handleOpen(url)
}

Objective-C

- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void(^)(NSArray *restorableObjects))restorationHandler {
    return [Bitly handleUserActivity:userActivity];
}

- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey, id> *)options {
    return [Bitly handleOpenUrl:url];
}

4. Retry on error

Swift

Bitly.retryError(error)

Objective-C

[Bitly retryError:error];

If there are any issues in handling a Universal Link the operation can be retried using the following line of code in your response handler from step 2

Configure the SDK for Shortening

1. Configure an OAUTH token for your app http://bitly.com/a/oauth_apps
2. Import the SDK in your AppDelegate

Swift

import BitlySDK

Objective-C

#import <BitlySDK/BitlySDK.h>

3. Initialize the SDK on application initialization

Swift

func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
    Bitly.initialize("YOUR_APP_ACCESS_TOKEN")
    return true
}

Objective-C

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [Bitly initialize:@"YOUR_APP_ACCESS_TOKEN"];
    return YES;
}

> You can combine this initialization with the App Link initialization

5. You can shorten from anywhere in your application

Swift

  Bitly.shorten("http://theurlyouwishtoshorten.com") { response, error in
      // response provides a BitlyResponse object which contains the shortened Bitlink
      // response includes a status code
      // error provides any errors in retrieving information about the URL
      // Your custom logic goes here...
  }

Objective-C

  [Bitly shorten:@"http://theurlyouwishtoshorten.com" handler:^(BitlyResponse * response, NSString * error) {
      // response provides a BitlyResponse object which contains the shortened Bitlink
      // response includes a status code
      // error provides any errors in retrieving information about the URL
      // Your custom logic goes here...
  }];