Reader SDK Quick Start

Step 2: Configure the Reader SDK sample app

Download the Reader SDK sample app from GitHub and follow the steps below to configure the sample app for your environment.

Android

  1. Download the Reader SDK sample app for Android.
  2. In ./gradle.properties, set the variables for your Square application ID and repository password from the Reader SDK settings page:
    SQUARE_READER_SDK_APPLICATION_ID={APPLICATION ID FROM STEP 1}
    SQUARE_READER_SDK_REPOSITORY_PASSWORD={REPO PASSWORD FROM STEP 1}
    
  3. Import the project in Android Studio.

If you run into errors while building the project, we recommend cleaning the project and reopening Android Studio before continuing.

iOS

  1. Download the Reader SDK sample app for iOS.
  2. In the sample app directory, install Reader SDK with the application ID and repository password (from the Reader SDK settings page):
    ruby <(curl https://connect.squareup.com/readersdk-installer) install \
    --app-id {APPLICATION ID FROM STEP 1}                                 \
    --repo-password {REPO PASSWORD FROM STEP 1}
    
  3. Open the project in Xcode.

If you run into errors while building the project, we recommend cleaning the project and reopening Xcode before continuing.

Prev
< Request Reader SDK credentials
Next
Take a cash payment >

Ask for help on Stack Overflow or join our Slack channel