Getting Started with the Facebook SDK for iOS

The Facebook SDK for iOS is the easiest way to integrate your iOS app with Facebook. It enables:

• Facebook Analytics - Understand how people are using your product.
• Facebook Login - Authenticate people with their Facebook credentials.
• Share and Send dialogs - Enable sharing content from your app to Facebook.
• App Events - Log events in your application.
• Graph API - Read and write to Graph API.

You have two ways to set up your app to use the Facebook SDK. If you haven't registered your application with Facebook, the simplest and quickest option is to use the Quick Start tool. The alternative is to skip the Quick Start and use the manual instructions below.

Manual Configuration

Step 1: Configure Facebook App Settings for iOS

Step 2: Link to the SDK

Step 3: Configure Xcode Project

Step 4: Connect App Delegate

Step 5: Add App Events

Step 1: Configure Facebook App Settings for iOS

1. Open the Facebook App Dashboard by clicking the button below.

Open Facebook App Dashboard

2. Select your app.
3. In the left navigation pane, select Settings -> Basic.
4. If the iOS platform isn't currently in your app, click Add Platform at the bottom of the page and select iOS.
5. Locate your bundle identifier in Xcode and copy it to your clipboard.



6. Return to the App Dashboard and paste your bundle identifier into the Bundle ID field.



7. Enable Single Sign On.
8. Click Save Changes at the bottom of the App Dashboard window.

Step 2: Link to the SDK

You can link to the SDK using the following methods:

Using Swift Package Manager (SPM)

Using CocoaPods

Using Carthage

Manually Installing Frameworks

Using Swift Package Manager (SPM)

1. In Xcode, click File > Add Package Dependency.
2. In the dialog that appears, enter the repository URL: https://github.com/facebook/facebook-ios-sdk.
3. In Version, select Up to Next Major 5.10.0
4. Complete the prompts to select the libraries you'd like to use in your project.
5. To use the Objective-C interface exclusively, import the 'FBSDK'-prefixed module.

   import FBSDKCoreKit

   To use the enhanced Swift interface in your code, import the 'Facebook'-prefixed module.

   import FacebookCore

Using Cocoapods

1. Navigate to your project folder in a terminal window.
2. Make sure you have the CocoaPods gem installed on your machine before installing the Facebook Login pod.

   $ sudo gem install cocoapods
   $ pod init

   This will create a file named Podfile in your project's root directory.


3. Add the following to your Podfile:

   pod 'FBSDKCoreKit'

   If using Facebook Login and Sharing, also add:

   pod 'FBSDKLoginKit'
   pod 'FBSDKShareKit'

4. Run the following command in your project root directory from a terminal window:

   $ pod install

Using Carthage

We support Carthage.

Your Cartfile should look something like:

github "facebook/facebook-ios-sdk"

Manually Installing Frameworks

Download and unzip the SDK and install the desired frameworks. Just ensure that the -ObjC flag is set.

Step 3: Configure Info.plist

1. In Xcode, right-click your project's Info.plist file and select Open As -> Source Code.

2. Insert the following XML snippet into the body of your file just before the final </dict> element.

<key>CFBundleURLTypes</key>
<array>
  <dict>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>fb{your-app-id}</string>
    </array>
  </dict>
</array>
<key>FacebookAppID</key>
<string>{your-app-id}</string>
<key>FacebookDisplayName</key>
<string>{your-app-name}</string>
<key>LSApplicationQueriesSchemes</key>
<array>
  <string>fbapi</string>
  <string>fb-messenger-share-api</string>
  <string>fbauth2</string>
  <string>fbshareextension</string>
</array>

3. Replace {your-app-id}, and {your-app-name} with your app's App's ID and name found on the Facebook App Dashboard.

Step 4: Connect App Delegate

To post-process the results from actions that require you to switch to the native Facebook app or Safari, such as Facebook Login or Facebook Dialogs, you need to connect your AppDelegate class to the FBSDKApplicationDelegate object. To accomplish this, add the following code to your AppDelegate.m or AppDelegate.swift file.

//  AppDelegate.swift
import FacebookCore

func application(
    _ application: UIApplication, 
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
) -> Bool {
    // Override point for customization after application launch.

    ApplicationDelegate.shared.application(
        application,
        didFinishLaunchingWithOptions: launchOptions
    )
    return true
}

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

//  AppDelegate.m
#import <FBSDKCoreKit/FBSDKCoreKit.h>

- (BOOL)application:(UIApplication *)application 
    didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  
  // You can skip this line if you have the latest version of the SDK installed
  [[FBSDKApplicationDelegate sharedInstance] application:application
    didFinishLaunchingWithOptions:launchOptions];
  // Add any custom logic here.
  return YES;
}

- (BOOL)application:(UIApplication *)application 
            openURL:(NSURL *)url 
            options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {

  BOOL handled =  [[FBSDKApplicationDelegate sharedInstance] application:application openURL:url options:options];
  // Add any custom logic here.
  return handled;
}

Step 5: Add App Events

Now that the SDK is installed and configured, the easiest way to test it is to add App Events to your app. App Events help you understand how people are using your app. This is done by logging events via one of 14 predefined events such as added to cart in a commerce app or level achieved in a game. You can even define your own custom events.

Log App Activations

To see how many people are using your application, log app activations by adding the following code to your AppDelegate.m file.

// AppDelegate.swift
import FacebookCore

func applicationDidBecomeActive(_ application: UIApplication) {
    AppEvents.activateApp()
}

//  AppDelegate.m
#import <FBSDKCoreKit/FBSDKCoreKit.h>
- (void)applicationDidBecomeActive:(UIApplication *)application {
  [FBSDKAppEvents activateApp];
}

To verify logging:

1. Compile and run your app.
2. Go to the Facebook Analytics Dashboard and select your app.

Open Facebook Analytics

3. From the menu on the left, select Activity -> Events.

There will be a short delay before your activations show on the event dashboard. If you don't see anything, wait a minute and refresh the page.

Next Steps

To learn how to implement App Events and other Facebook products to your app, click one of the buttons below.