Latest revision as of 14:52, 2 March 2020

Download the SDK

Extract the zip file's contents and drag & drop the SocialID.framework file to the "Frameworks" folder in your XCode project.

Download the SDK

SDK Dependencies

• iOS: 10.3+
• FacebookSDK.framework (version 4.40.0) [for Facebook login]
• GoogleSignIn (version 4.4.0) [for Google login]
• TwitterCore (version 3.2.0) [for Twitter login]
• TwitterKit (version 3.4.2) [for Twitter login]
• SystemConfiguration.framework
• AuthenticationServices.framework
• UIKit.framework
• Foundation.framework

The Facebook, Google and Twitter SDKs also have its own dependencies. Follow the next instructions to setup them.

The current Social-ID SDK was built and tested against the SDK versions listed above. You can also try to use earlier or later dependency versions case your project requires it, the social network SDKs (e.g. Facebook) are compatible in general. Contact us case you have issues with the Social-ID SDK when building your project.

Setup Facebook iOS SDK

Follow the instructions here (from steps 1 to 3) if you didn't already.

You need to follow the steps 1, 2, 3 and 4:

• 1. Configure Facebook App Settings for iOS
• 2. Link to the SDK
• 3. Configure Info.plist

Setup Google iOS SDK

Follow the instructions here if you didn't already.

Step List:

• Download the Google Sign-In SDK
• Add the SDK your Xcode project
• Link dependent frameworks to your Xcode project
• Get an OAuth client ID
• Add a URL scheme to your project

You need to follow all instructions except the last step ("Next Steps"), as any configuration inside the code is done through the SocialID SDK.

Setup TwitterKit iOS SDKs

The Twitter login is provided by TwitterKit for iOS. Follow the instructions here to install the SDKs.

Step list:

• Obtain Application Key & Secret
  • Add a callback url to the Application's Callback URL list using the following format (see documentation):

 twitterkit-CONSUMERKEY://

Example:

 twitterkit-128238aKjqlp123AKdasdf://

• Install TwitterKit using Cocoapods, Carthage or manually.
  • Ensure to add both TwitterKit and TwitterCore to "Embedded Binaries" in your Xcode project "General" settings, otherwise you can have runtime errors like "Reason: image not found".
• Configure Info.Plist

The Social-ID iOS SDK already initializes the TwitterKit when the Twitter login is initialized. However, you will need to configure the TwitterConsumerKey and TwitterConsumerSecret in your app Info.plist file (see the instructions below).

Setup Sign In with Apple

Apple introduced the brand new "Sign In with Apple" capability for web and apps. If you use any social login in your iOS app you'll need to also add the "Sign In with Apple" option to be in compliance with Apple Store Review Guidelines.

Follow this steps:

• Generate App ID and Key following the configuration guide
• Enable the "Sign In with Apple" capability for your app in Xcode
• Important: this new capability is available only for iOS 13.0+

Get your SocialID Data

You will need 2 variables to configure the Social-ID SDK:

• applicationId: Set up a Social-Id LoginApp at: https://app.socialidnow.com/marketing/login/apps. Your key is the id of the app.
• applicationClientSecret: The API client secret can be found on the Call the API menu - https://app.socialidnow.com/marketing/login/apps/APP_ID/apis.

Setup the Social-ID SDK

Add the following statement to your ViewController:

 #import <SocialID/SocialID.h>

Add the following code to the "application:didFinishLaunchingWithOptions" method in your App Delegate implementation file:

   - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
       
       // Initialize SocialID SDK (use the data you collected in the "Get your SocialID data" step):
       SocialID setApplicationId:XXX clientSecret:@"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"];
       
       // Initialize application session to access application APIs:
       if (![SIDAppSession isLoggedIn]) {
           [SIDAppSession refreshToken:^(SIDToken *token) {
               // handle success if you want
           } failure:^(NSError *error) {
               // handle failure if you want
           }];
       }
       
       // Initialize social logins, including the scopes you want to ask to the user:
       [SIDFacebook initializeFacebook];
       [SIDFacebook setPermissions:@[ @"public_profile", @"email", @"user_birthday" ]];
       [SIDGoogle initializeGoogle];
       [SIDGoogle setScopes:@[ @"profile", @"email", @"https://www.googleapis.com/auth/user.birthday.read" ]];
       [SIDLinkedin initializeLinkedin];
       [SIDLinkedin setScopes:@[ @"r_emailaddress", @"r_liteprofile" ]];
       [SIDTwitter initializeTwitter];
       [SIDApple initializeProvider];
       
       // Set the user profile fields you want to retrieve when the user logs in;
       [SIDLogin setUserFields:@"display_name,picture_url,current_location,verified_email,picture_urls"];
       
       // Trigger finish launching for login
       [SIDLogin application:application didFinishLaunchingWithOptions:launchOptions];
       
       // your code
      
       return YES;
   }

Add the following method to your app delegate implementation file:

iOS 4.2–9.0:

 - (BOOL) application: (UIApplication *)application
              openURL: (NSURL *)url
    sourceApplication: (NSString *)sourceApplication
           annotation: (id)annotation {
     return [SIDLogin application:application
                          openURL:url
                sourceApplication:sourceApplication
                       annotation:annotation];
 }

iOS 9.0+:

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

Modify Info.plist

If you followed the first steps correctly, you should already have the following Facebook data in your app Info.plist file:

• FacebookAppID
• FacebookDisplayName
• fb{FACEBOOK_APP_ID} in the URL types

You should also already have your bundle ID as an URL type, that is required by Google+ SDK. You will need to add one more item to make Google+ login work:

• GoogleClientID: The Client ID for your "Client ID for iOS application" (found in APIs & auth -> Credentials)

For LinkedIn login, you will need to add two more items to make it work:

• LinkedinAPIKey: the Client ID of your LinkedIn app
• LinkedinAPISecret: the Client Secret of your LinkedIn app

For Twitter login, you need to add two more items:

• TwitterConsumerKey: the API / consumer key you set up on the Twitter OAuth1 app
• TwitterConsumerSecret: the API / consumer secret you set up on the Twitter OAuth1 app

Preparing for iOS 9

The iOS 9 requires some changes in app configuration.

Bitcode Error

Google+ SDK requires Bitcode to be disabled. You should change the following variable in X-Code:

 Project > Build Settings > Build Options > Enable Bitcode = No

Facebook iOS 9 Guide

Follow these steps from Facebook iOS 9 guide:

• Whitelist Facebook Servers for Network Requests
• Whitelist Facebook Apps

The Social-ID SDK uses the Facebook 4.7.0, so you need to add the following entries for LSApplicationQueriesSchemes:

 <key>LSApplicationQueriesSchemes</key>
 <array>
       <string>fbapi</string>
       <string>fb-messenger-share-api</string>
       <string>fbauth2</string>
       <string>fbshareextension</string>
 </array>

Also, the new Facebook SDK login behavior prioritizes the login via SafariViewController instead of the login via Facebook native app. For more information see https://developers.facebook.com/bugs/786729821439894/?search_id.

Whitelist Google+ Application Schemes

Add the following entries for LSApplicationQueriesSchemes in your app Info.plist file:

 <key>LSApplicationQueriesSchemes</key>
 <array>
   <string>[APP BUNDLE ID]</string>
   <string>com.google.gppconsent</string>
   <string>gplus</string>
   <string>com-google-gidconsent-google</string>
   <string>com-google-gidconsent-youtube</string>
   <string>com-google-gidconsent</string>
   <string>com.google.gppconsent.2.4.1</string>
   <string>com.google.gppconsent.2.4.0</string>
   <string>googlechrome</string>
   <string>googlechrome-x-callback</string>
 </array>

Whitelist Twitter Servers for Network Requests

Add the following entries for NSAppTransportSecurity in your app Info.plist file:

 <key>NSAppTransportSecurity</key>
 <dict>
   <key>NSExceptionDomains</key>
   <dict>
       <key>twimg.com</key>
       <dict>
           <key>NSIncludesSubdomains</key>
           <true/>                
           <key>NSThirdPartyExceptionRequiresForwardSecrecy</key>
           <false/>
       </dict>
   </dict>
 </dict>

Known Issues

Unsupported Architectures

The TwitterCore and TwitterKit frameworks contain unsupported architectures (x86_64, i386). When you build your app to Beta Testing or Apple Store you may face the following issues (example using fastlane):

 ERROR ITMS-90087: "Unsupported Architectures. The executable for SocialID Toolbox.app/Frameworks/TwitterCore.framework contains unsupported architectures '[x86_64, i386]'."
 ERROR ITMS-90087: "Unsupported Architectures. The executable for SocialID Toolbox.app/Frameworks/TwitterKit.framework contains unsupported architectures '[x86_64, i386]'."

To fix this issue you can run a script in the Build Phase to extract these unsupported architectures:

 APP_PATH="${TARGET_BUILD_DIR}/${WRAPPER_NAME}"
 
 # This script loops through the frameworks embedded in the application and
 # removes unused architectures.
 find "$APP_PATH" -name '*.framework' -type d | while read -r FRAMEWORK
 do
     FRAMEWORK_EXECUTABLE_NAME=$(defaults read "$FRAMEWORK/Info.plist" CFBundleExecutable)
     FRAMEWORK_EXECUTABLE_PATH="$FRAMEWORK/$FRAMEWORK_EXECUTABLE_NAME"
     echo "Executable is $FRAMEWORK_EXECUTABLE_PATH"
     
     EXTRACTED_ARCHS=()
     
     for ARCH in $ARCHS
     do
         echo "Extracting $ARCH from $FRAMEWORK_EXECUTABLE_NAME"
         lipo -extract "$ARCH" "$FRAMEWORK_EXECUTABLE_PATH" -o "$FRAMEWORK_EXECUTABLE_PATH-$ARCH"
         EXTRACTED_ARCHS+=("$FRAMEWORK_EXECUTABLE_PATH-$ARCH")
     done
     
     echo "Merging extracted architectures: ${ARCHS}"
     lipo -o "$FRAMEWORK_EXECUTABLE_PATH-merged" -create "${EXTRACTED_ARCHS[@]}"
     rm "${EXTRACTED_ARCHS[@]}"
     
     echo "Replacing original executable with thinned version"
     rm "$FRAMEWORK_EXECUTABLE_PATH"
     mv "$FRAMEWORK_EXECUTABLE_PATH-merged" "$FRAMEWORK_EXECUTABLE_PATH"
     
 done