getting started - qwasi/ios-pushkit GitHub Wiki

Introduction to the QWASI iOS SDK

Building an Application using the QWASI iOS SDK (PushKit.framework) requires several steps prior to coding. This document assumes all Apple iOS Developer accounts have been setup and established. We will guide you through:

The next document will assist you in configuring your App and ensuring it has been initialized in Xcode and is ready for integration with the QWASI iOS SDK. This document will provide the reader with a guide to the creation of a proper iOS provisioning profile, generating APNs Push Certificates and the setting up of Xcode.

Requirements

Knowledge of programming languages, the iOS SDK and an account with iOS developer access is required.

Creating and Configuring your iOS App ID

Please Note: If you have already provisioned an application, this section can be skipped.

  1. Open a browser to https://developer.apple.com and login with a valid iOS Developer Account.

  2. Follow the Certificates, Identifiers, and Profiles link in Developer Program Resources section.

    Developer Program Resources

  3. Select iOS Apps Identifiers in the Certificates, Identifiers and Profiles page.

    Certificates, Identifiers and Profiles

  4. Create an iOS App ID by pressing the icon in the upper right corner.

    Create New Profile

  5. Configure your App ID and specify a Bundle ID. Your Bundle ID should contain your App Name such as com.company.AppName. Take note of your Bundle ID for your app. This will be used later to configure the QWASI Push Channel.

    (The following two screen shots are from the same App ID Registration page)

    Configure AppID
    Also, you must select Push Notifications in the App Services Section if you wish to use QWASI Push Notifications

    Configure AppID

  6. Confirm your App ID and press Submit

    Confirm APP ID

Create a Push Certificate for your iOS Application

Please Note: If you have already provisioned an application for push and created the Application Certificates, this section does not apply.

Apple makes a distinction between development and production (distribution) profiles for applications. This section describes the process for provisioning an ‘in-development’ application. The process for production applications is analogous. The following are the steps to complete this task.

  1. Select iOS Apps Identifiers in the 'Certificates, Identifiers and Profiles' page.

    Certificates, Identifiers and Profiles

  2. Click on Application you wish to generate the New Certificate for from the list of App IDs. (In this case we will be selecting NewPushApp)

    Certificates

  3. Click Edit to edit the App ID.

  4. Scroll down to Push Notifications - enable it by selecting the check box if it's not already. Push the Create Certificate button.

    Certificates

  5. Follow the instructions to create a Certificate Request (CSR). Certificate Request

  6. Upload the CSR you just created and Generate the certificate Generate Certificate

  7. Once your certificate is ready – Download the certificate.Download Certificate

  8. Double click on the certificate in your Downloads folder and Keychain Access will open. The certificate should be in the login Keychain under My Certificates. You'll find the certificate with a prefix of Apple Development IOS Push Services followed by the identifier you chose. If it is not, you may need to exit Keychain and open it again. This step is often the most difficult part of the process.

  9. Click on the little gray triangle to expand the certificate and unveil the private key.

  10. Select both the certificate and the private key.

    Select Certificate and Private Key

  11. Choose the menu File > Export Items…

    Export Items

  12. Choose a location and a file name and Save the certificate as a Personal information Exchange (.p12) file.

  13. Insert a password and verify it.

    Password

  14. Now you'll be asked to insert the Password of your current account on your Mac

  15. Click Allow or Always Allow.

    Allow or Always Allow

  16. You are now finished creating your p12 Push Certificate.

Please Note: You will need to provide this certificate file to configure your QWASI Push Channel. You will then need to follow the same steps above to create a Production Certificate. Please provide these certificates, the certificate passwords and bundle identifier to your Account Representative.



Create a Provisioning Profile

The Provisioning Profile is necessary in order to install your development applications on devices that you will use for development and testing.

  1. Select iOS Apps Provisioning Profiles in the Certificates, Identifiers and Profiles page.

  2. Click on the to create a new profile.

    Provisioning Profile

  3. From the Development section, select iOS App Development and click Continue.

    Provisioning Profile Dev

  4. Select the App ID for your application and click Continue.

    Provisioning Profile Dev

  5. You will be asked to select any certificates you want to include in the profile. Only the developers chosen here will be able to work with the application in Xcode. Choose your certificate and click ‘Continue’.

    Provisioning Profile Developers

  6. On the next screen you will be able to select the valid testing devices. Select as many as you like, you can change this later. To add more devices, plug the device into your Mac and use the Xcode Organizer

    Select Test Devices

  7. On the following screen you will name the profile, then click Generate.

    Select Test Devices

  8. The Provisioning Profile is now ready. Download the profile and open it. Xcode will launch and the profile will be installed.

You are now ready to begin creating your application. In the next section we will walk you through creating your application and configuring it for Push and Location using the QWASI Framework.

⚠️ **GitHub.com Fallback** ⚠️