iOS SDK

Get Started: Facebook SDK for iOS (SPM)

This guide shows you how to integrate your iOS app with Facebook using the Facebook SDK for iOS.

Beginning with SDK v13.0, set to release in early 2022, a Client Token will be required for all calls to the Graph API.

The Facebook SDK enables:

This topic will help you get started using the Facebook SDK for iOS using SPM to import the Facebook components. If you use CocoaPods, see Get Started (CocoaPods).

Before You Start

This procedure assumes you are using the latest version of iOS and Xcode. Learn more at the Apple Developer.

Note: To follow these instructions, create a project with UIKit App Delegate selected for Life Cycle. The following image shows an example:

You will need:

  1. A Facebook for Developers Account If you need one, click this button and follow the steps. Create a Facebook for Developers Account


  2. An App ID for Your App: Click the button that follows and follow the steps to register your app and get an App ID
    Get an App ID for your app

    3. Step 1: Set Up Your Development Environment

    1. In Xcode, click File > Swift Packages > 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 and the default option.
    4. Complete the prompts to select the libraries you want to use in your project.
      5. If You Want ToAdd This Package to your project

      Allow your app to use the Facebook services

      FacebookCore

      Allow users to log into your app to enable engagement and promote social features

      FacebookGamingServices

      Allow users to log into your app and for your app to ask for permissions to access data

      FacebookLogin

      Allow your app to share content on Facebook

      FacebookShare

    Step 2: Register and Configure Your App with Facebook

    Visit our App Development - Platform Settings guide to register and configure your app.

    Step 3: Configure Your Project

    Configure the Info.plist file with an XML snippet that contains data about your app.
    1. Right-click Info.plist, and choose Open As ▸ Source Code.
    2. Copy and paste the following XML snippet into the body of your file ( <dict>...</dict>). 
      <key>CFBundleURLTypes</key>
<array>
  <dict>
  <key>CFBundleURLSchemes</key>
  <array>
    <string>fbAPP-ID</string>
  </array>
  </dict>
</array>
<key>FacebookAppID</key>
<string>APP-ID</string>
<key>FacebookClientToken</key>
<string>CLIENT-TOKEN</string>
<key>FacebookDisplayName</key>
<string>APP-NAME</string>
    3. In <array><string> in the key [CFBundleURLSchemes], replace APP-ID with your App ID.
    4. In <string> in the key FacebookAppID, replace APP-ID with your App ID.
    5. In <string> in the key FacebookClientToken, replace CLIENT-TOKEN with the value found under Settings > Advanced > Client Token in your App Dashboard.
    6. In <string> in the key FacebookDisplayName, replace APP-NAME with the name of your app.
    7. To use any of the Facebook dialogs (e.g., Login, Share, App Invites, etc.) that can perform an app switch to Facebook apps, your application's Info.plist also needs to include: <dict>...</dict>). 
      <key>LSApplicationQueriesSchemes</key>
<array>
  <string>fbapi</string>
  <string>fbapi20130214</string>
  <string>fbapi20130410</string>
  <string>fbapi20130702</string>
  <string>fbapi20131010</string>
  <string>fbapi20131219</string>
  <string>fbapi20140410</string>
  <string>fbapi20140116</string>
  <string>fbapi20150313</string>
  <string>fbapi20150629</string>
  <string>fbapi20160328</string>
  <string>fbauth</string>
  <string>fb-messenger-share-api</string>
  <string>fbauth2</string>
  <string>fbshareextension</string>
</array>

    Step 4: Connect the App Delegate

    Upon initialization, the SDK will perform various network calls to fetch configuration information. If you would like to defer these operations you may want to wrap initialization in a method that can conditionally run code based on a server response. There are a number of ways to do this. The following code block is pseudocode to demonstrate what a potential solution might look like. 
    FlagFetcher.fetchFlags { result in
    if case let .success(flags) = result,
      flags.contains("use_facebook") {
        // Initialize the SDK
        ApplicationDelegate.shared.application(
            application,
            didFinishLaunchingWithOptions: launchOptions
        )			
    }
}
    Replace the code in the AppDelegate method with the following code. This code initializes the SDK when your app launches, and allows the SDK handle results from the native Facebook app when you perform a Login or Share action.

    Swift

        
// Swift
//
// AppDelegate.swift
import UIKit
import FBSDKCoreKit

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
    
    func application(
        _ application: UIApplication,
        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
    ) -> Bool {
          
        ApplicationDelegate.shared.application(
            application,
            didFinishLaunchingWithOptions: launchOptions
        )

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

        ApplicationDelegate.shared.application(
            app,
            open: url,
            sourceApplication: options[UIApplication.OpenURLOptionsKey.sourceApplication] as? String,
            annotation: options[UIApplication.OpenURLOptionsKey.annotation]
        )

    }  

}

    Objective C

    // Objective-C
//
// AppDelegate.m  
@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  
  [[FBSDKApplicationDelegate sharedInstance] application:application
                           didFinishLaunchingWithOptions:launchOptions];
  return YES;
}


- (BOOL)application:(UIApplication *)application
            openURL:(NSURL *)url
            options:(nonnull NSDictionary<UIApplicationOpenURLOptionsKey, id> *)options
{
  [[FBSDKApplicationDelegate sharedInstance] application:application
                                                 openURL:url
                                                 options:options];
  return YES;
}
    iOS 13 moved opening URL functionality to the SceneDelegate. If you are using iOS 13, add the following method to your SceneDelegate so that operations like logging in or sharing function as intended:

    Swift

    // Swift
//
// SceneDelegate.swift
import FBSDKCoreKit
  ...
func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
    guard let url = URLContexts.first?.url else {
        return
    }

    ApplicationDelegate.shared.application(
        UIApplication.shared,
        open: url,
        sourceApplication: nil,
        annotation: [UIApplication.OpenURLOptionsKey.annotation]
    )
}

    Objective C

    // Objective-C
//
// SceneDelegate.m
#import <FBSDKCoreKit/FBSDKCoreKit.h>

@import FacebookCore;

@interface SceneDelegate ()

@end

@implementation SceneDelegate

- (void)scene:(UIScene *)scene openURLContexts:(NSSet<UIOpenURLContext *> *)URLContexts
{
  UIOpenURLContext *context = URLContexts.allObjects.firstObject;
  [FBSDKApplicationDelegate.sharedInstance application:UIApplication.sharedApplication
                                               openURL:context.URL
                                     sourceApplication:context.options.sourceApplication
                                            annotation:context.options.annotation];
}

    Step 5: Build and Then Run Your Project in the Simulator

    In Xcode, select an iOS simulator and click Run. Xcode builds your project and then launches the most recent version of your app running in Simulator.

    Step 6: See the Results in Events Manager

    The Events Manager displays the events you send to Facebook Analytics. If this is the first time you launched your app with this code, you may have to wait at least 20 minutes before your events appear.
    Note: Events may take up to 20 minutes to appear in the dashboard.

    Next Steps

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

    Sharing in iOSAdd Facebook LoginAdd App EventsUse Graph API
    Advanced Configuration