canvaspop-ios-library

Our Photo Printing API is a great way for app developers, brands, and website owners to monetize their visual content and make it easy for their customers to turn their images into beautiful canvas prints.

The iOS library helps you integrate our Photo Printing API in less than half an hour! Follow the instructions provided below to integrate the library within your iOS application. The library is universal and works on both iPhone and iPad devices.

Once a print is purchased within your application, our designers can turn any image into a big beautiful canvas. We print, package, and ship all orders with love directly to your customers.

Current version: 1.0.8 (download)

Installation via Cocoapods

Installing the library is simple and should only take a few minutes. This may be done manually or via cocoapods.

Add the following to your Podfile:

pod 'PopUpLib'

Run pod install

This will give you all of the necessary files to begin integrating our photo printing API. For next steps, see the section on 'Integration' below.

Manual Installation

Installing PopUpLib SDK is simple.

1. Download the repo from github then unzip it and use Finder to move PopUpLib.framework within your application's folder.

2. Drag PopUpLib.framework into your project's Frameworks folder within the Project Navigator. You may need to create the Frameworks group.

   

3. In the General tab of your app's Target, under the "Embedded Binaries" section, hit the add button and add PopUpLib.framework.

   

You're now ready to integrate the SDK. If you encounter any issues, please feel free to report them here: https://github.com/canvaspop/canvaspop-ios-library/issues

Integration

Integrating the CanvasPop iOS library into your app is very simple.

There are two main files included with the framework.

File	Description
PopUpLib.h	The file you include in your project i.e. #import <PopUpLib/PopUpLib.h>
PopUpStoreController.h	The view controller you will need to instantiate and present

1. If your application is written in Objective-C, choose where your users will launch the Pop-up Store Controller and add

   #import <PopUpLib/PopUpLib.h>

   inside the header file for your controller.

   If you're using Swift, the import needs to go in a bridging header. Create a <MyAppName>-Bridging-Header.h file if your project doesn't have one. In your project's Build Settings, ensure the Objective-C Bridging Header setting references the file you just added (probably <MyAppName>/<MyAppName>-Bridging-Header.h)

   

2. Implement the PopupStoreControllerDelegate protocol in your controller:

   Swift:

   class ViewController: UIViewController, PopupStoreControllerDelegate {
   }

   Objective-C:

   @interface ViewController : UIViewController <PopupStoreControllerDelegate> {
   }

3. At the desired time (e.g. tapping a button, after taking/editing a photo), instantiate a PopupStoreController. If one was created successfully (i.e. the call did not return nil), present the Pop-up Store controller.

   Parameters

   • image - the image that will be printed on canvas
   • applicationKey - your partner API key
   • delegate - Any class that implements the PopupStoreControllerDelegate protocol (usually self)

   Objective-C:

   PopupStoreController *controller =  [[PopupStoreController alloc] 
                                       initWithImage:[UIImage imageNamed:@"your_desired_image.jpg"] 
                                       applicationKey:YOUR_PARTNER_KEY 
                                       delegate:self];
                                                                    
   if (controller) {
       [self presentViewController:controller animated:YES completion:NULL];
   }

   Swift:

   if let controller = PopupStoreController(
       image: myImage,
       applicationKey: "YOUR_PARTNER_KEY",
       delegate: self) {
       self.present(controller, animated: true, completion: nil)
   }

   Status Bar

   The iOS library provides support to show or hide the status when using PopupStoreController. By default the library will hide the status bar. If you wish to use this option you may set it with a bool value using the setLibShouldShowStatusBar method shown below.

   Objective-C:

   PopupStoreController *popUpStoreController = [[PopupStoreController alloc] initWithImage:[UIImage imageNamed:@"your_desired_image.jpg"] applicationKey:YOUR_PARTNER_KEY delegate:self];
   
   [popUpStoreController setLibShouldShowStatusBar:<STATUS_BAR_PREFERENCE>];
   
   [self presentViewController:popUpStoreController animated:YES completion:NULL];

   Swift:

   if let controller = PopupStoreController(
       image: myImage,
       applicationKey: "YOUR_PARTNER_KEY",
       delegate: self) {
       controller.shouldDisplayStatusBar = <STATUS_BAR_PREFERENCE>
       self.present(controller, animated: true, completion: nil)
   }

4. Implement the PopupStoreControllerDelegate protocol. There are currently six delegate methods; one that is required and five that may be optionally implemented. They are as follows:

   Required

   Objective-C:

   - (void)popupStoreLibWasClosed:(PopupStoreController *)lib
   {
       /*
       * Here a user has closed the Pop-up Store controller and it must be dismissed
       */
       [self dismissViewControllerAnimated:YES completion:nil];
   }

   Swift:

   func popupStoreLibWasClosed(_ controller: PopupStoreController!) {
       self.dismiss(animated: true, completion: nil)
   }

   Optional

   The following methods are optional and may be implemented to receive callbacks.

   Objective-C:

   - (void)popupStoreLibWasOpened:(PopupStoreController *)lib
   {
       /*
       * Here a user has opened the Pop-up Store controller successfully
       */
       NSLog(@"Pop-up Store lib was opened");
   }
   
   - (void)popupStoreLibUserTappedContinue:(PopupStoreController *)lib
   {
       /*
       * Here a user has tapped the continue button after the initial image handshake was completed
       * The user will then be taken to the store with their desired image
       */
       NSLog(@"Pop-up Store user tapped continue");
   }
   
   - (void)popupStoreWasLoadedWithImage:(PopupStoreController *)lib
   {
       /*
       * Here the web request to load Pop-up Store with a users image completed successfully
       * A user is presented with a cart containing their image and print options
       */
       NSLog(@"Pop-up Store cart page loaded successfully with image");
   }
   
   - (void)popupStoreLibPrintHandshakeCompleted:(PopupStoreController *)lib
   {
       /*
       * The library implements a two-step handshake documented here: https://developers.canvaspop.com/documentation/image-handshake#two-step
       * Here the high resolution, printable version of the desired image was uploaded succesfully
       * 
       */
       NSLog(@"Pop-up Store print image handshake completed");
   
   - (void)popupStoreEventWasEmitted:(PopupStoreController *)controller withEvent:(NSString*)eventName withPayload:(NSDictionary *)payload
   {
       /*
       * Here a user has interacted with Pop-up Store and an HTML5 pushMessage() was emitted.
       * Depending on the event, it may have an associated payload value sent along with the event name.
       * 
       * For further details on emitted events and their payloads see here: 
       * https://developers.canvaspop.com/documentation/events
       */
       
       NSLog(@"PopupStore event was emitted with payload");
       
       NSLog(@"Event: %@", eventName);
   
       if(payload)
           NSLog(@"Payload: %@", payload);
   }

   Swift:

   func popupStoreLibWasOpened(_ controller: PopupStoreController!) {
      /*
       * Here a user has opened the Pop-up Store controller successfully
       */
       print("PopUp Store was opened!")
   }
   
   func popupStoreLibUserTappedContinue(_ controller: PopupStoreController!) {
      /*
       * Here a user has tapped the continue button after the initial image handshake was completed
       * The user will then be taken to the store with their desired image
       */
      print("Pop-up Store user tapped continue")
   }
   
   func popupStoreWasLoaded(withImage controller: PopupStoreController!) {
       /*
       * Here the web request to load Pop-up Store with a users image completed successfully
       * A user is presented with a cart containing their image and print options
       */
       print("Pop-up Store cart page loaded successfully with image")
   }
   
   func popupStoreLibPrintHandshakeCompleted(_ controller: PopupStoreController! ) {
      /*
       * The library implements a two-step handshake documented here: https://developers.canvaspop.com/documentation/image-handshake#two-step
       * Here the high resolution, printable version of the desired image was uploaded succesfully
       * 
       */
      print("Pop-up Store print image handshake completed")
   }
   
   func popupStoreEventWasEmitted(_ controller: PopupStoreController!, withEvent eventName: String!, withPayload payload: [AnyHashable : Any]!) {
      /*
       * Here a user has interacted with Pop-up Store and an HTML5 pushMessage() was emitted.
       * Depending on the event, it may have an associated payload value sent along with the event name.
       * 
       * For further details on emitted events and their payloads see here: 
       * https://developers.canvaspop.com/documentation/events
       */
       print("got event: \(String(describing: eventName))")
       if (payload != nil) {
           print ("Payload \(payload.debugDescription)")
       }
   }

5. Before archiving your app for the app store, add a new Run Script Phase to your application target’s Build Phases below the Embed Frameworks build phase. Paste the contents of the strip-frameworks.sh file (found in the zipfile) into this Run Script Phase's script text field:

   strip-frameworks.sh
   

This removes simulator versions of the PopUpLib library from the framework and is a requirement for submission to the app store.

Support

We're always happy to help out with code or any other questions you might have. It's important to us that you are able to get PopUp Store integrated into your application as quickly and smoothly as possible.

Email: api.support@canvaspop.com

Twitter: CanvasPopApi

Looking for more information on the API itself? Check out https://developers.canvaspop.com/

Bugs

Noticed a bug in the library or documentation?

Please feel free to report any issues here: https://github.com/canvaspop/canvaspop-ios-library/issues