LaunchKey iOS SDK

• Overview
• Pre-Requisites
• Obtaining the Framework
  • Dependency Management
  • Manual Installation
• Usage
• Support

Overview

LaunchKey is an identity and access management platform This iOS SDK enables developers to quickly integrate the LaunchKey platform and iOS based applications without the need to directly interact with the platform API.

Developer documentation for using the LaunchKey API is found here.

An overview of the LaunchKey platform can be found here.

Pre-Requisites

Utilization of the LaunchKey SDK requires the following items:

• LaunchKey Account - The LaunchKey Mobile App is required to set up a new account and access the LaunchKey Dashboard.

• An application - A new application can be created in the LaunchKey Dashboard. From the application, you will need the following items found in the keys section of the application details:

  • The rocket key
  • The secret key
  • The private key

Obtaining the Framework

The framework, source, and doc files are available through either CocoaPods or GitHub.

Manual Installation (Not Suggested)

Download the framework for the LaunchKey SDK and add them to your project:

• LaunchKey SDK

Usage

1. Initialize the LKAuthenticationManager

   [[LKAuthenticationManager sharedClient] init:@"Your Rocket Key"
                                  withSecretKey:@"Your Secret Key"
                                 withPrivateKey:@"Your Private Key"];

2. Use the SDK

   • Authorize a user identifier via LaunchKey. The identifier can either be the LaunchKey username, userPushId or unique identifier (used in the whitelabel pairing process)

     [[LKAuthenticationManager sharedClient] authorize:@"identifier" withSuccess:^(NSString *userHash, NSString *authRequest, NSString *userPushId, NSString *deviceId) {
     
     } withFailure:^(NSString *errorMessage, NSString *errorCode) {
         //error handling
     }];

   • Determine whether the username is still authorized (i.e. has not remotely ended the session)

     [[LKAuthenticationManager sharedClient] isAuthorized:@"authRequest" withSuccess:^(BOOL authorized) {
     
     } withFailure:^(NSString *errorMessage, NSString *errorCode) {
         //error handling
     }];

   • End a session

     [[LKAuthenticationManager sharedClient] logout:@"authRequest" withSuccess:^{
     
     } withFailure:^(NSString *errorMessage, NSString *errorCode) {
         //error handling
     }];

   • Add a white label user

     [[LKAuthenticationManager sharedClient] createWhiteLabelUser:@"identifier"withSuccess:^(NSString *qrCode, NSString *qrUrl) {
         // Show the user the QR Code from the QR Code URL to be validated in a white label application
     } withFailure:^(NSString *errorMessage, NSString *errorCode) {
         //error handling
     }];
     

Support

GitHub

Submit feature requests and bugs on GitHub.

Twitter

Submit a question to the Twitter Handle @LaunchKeyHelp.

IRC

Engage the LaunchKey team in the #launchkey chat room on freenode.

LaunchKey Help Desk

Browse FAQ's or submit a question to the LaunchKey support team for both technical and non-technical issues. Visit the LaunchKey Help Desk here.