LogoLogo
  • Overview
    • About
    • Integrations
      • Perkville API
      • Partners
      • Integrating Perkville
        • API requirements
        • Automating your program using Perkville's API
        • Integrating Your Mobile App with Perkville
          • Page to initiate the PKCE flow.
          • Joining the loyalty program
          • Referral page
            • Referred prospects
          • Point history page
          • Earning rules page
          • Rewards page
            • Redeem confirmation page
          • Vouchers page
            • Mark voucher used confirmation page
          • Challenges page
            • Challenge details page
      • Integration Reference
        • ABC Ignite
          • ABC Ignite Engagement app
            • Home screen
            • Intro page
            • Authorize ABC Fitness page
            • Points page
            • Earning page
            • Rewards page
              • Redeem reward
              • Reward voucher
            • Referral page
        • Mariana Tek
        • Shopify
    • Security
  • Features
    • Loyalty program rules
      • Earning rules
        • Join
        • Birthday
        • Custom
        • Referral
          • Referral offer
          • Completing a referral
          • Referral flow
            • 1. Share referral offer
            • 2.Receive referral offer
            • 3. View offer details
            • 4. Claim offer
            • 5. Receive voucher
            • 6. Earn points for completed referral
        • Twitter (X)
        • Activities
      • Redeeming rules
        • Custom rewards
          • Initial voucher status
        • External rewards
    • Promotions
      • Frequency bonus
        • For customers: How a monthly/weekly bonus works
      • Time bonus
      • Promotion bonus
    • Challenges
      • Creating a challenge
      • Manually adding challenge progress
    • Emails
      • Invitations
      • Point earning notification
      • Weekly summary
      • Redemption
      • Challenge emails
        • Challenge invitation
        • Challenge progress notification
    • Managing customers
      • Referrals
      • Customer profile
        • Managing customer emails
        • Program Status
        • Ad-hoc points, redemptions, and adjustments
        • Transfer account data
        • Voiding transactions
        • Perkville email subscription status
        • Reversing a user's Perkville account closure
      • Bulk point updates
        • Add / Redeem page
        • CSV upload
      • Inviting customers
      • Export customer list
    • Settings
      • Advanced
        • Agreements
        • Allowed registration URLs
        • Business dashboard message section
        • Integration platform
        • Join restriction
        • Membership settings
        • Prohibit staff from earning or redeeming points
        • Referral offer claim options
      • Advertising
      • Business info
      • Branding
        • Branding step 1: logo and colors
        • Branding step 2: web pages and emails
        • Setting up a custom branded domain
        • Setting up custom branded emails
      • Challenges
        • Global Challenge Settings
        • Challenge Settings
        • Challenge Progress Activities
        • Challenge Rewards
        • Challenge Invitations
      • Locations
      • Prohibit Customers
      • Staff members
      • Redeeming options
    • Vouchers
    • Reports
      • Customer list export with points
      • Challenge Overview
      • Points By Location
      • Redemption Details
      • Redemption Overview
      • Referral Details
      • Referral Overview
      • Registration Rate Overview
    • Agency
      • Ad terms
      • Suppressions
      • Advertisers
      • Images
      • Creatives
      • Campaigns
      • Obtaining business approval
  • FAQs
    • End customer FAQs
      • I'm unable to join a business' loyalty program. What should I do?
      • Freeing up your Gmail address if you accidentally created a duplicate account
    • Miscellaneous
      • Protecting against password reuse
      • Is it possible to pre-populate the email address field on the page for joining the reward program?
      • I need to change the support email that displays in the footer. How can I do that?
      • I would like to reactivate my business' Perkville account.
      • How do I control my email notifications?
      • How do I update my billing information (e.g. credit card on file)?
    • Onboarding
      • Can Perkville migrate data from other loyalty / rewards software platforms?
      • Is it possible to invite customers with a link in our own emails rather than through Perkville?
      • The reward images that I added look blurry. How can I fix this?
    • Managing emails and names
      • Can you merge two emails into the same account?
      • I would like to correct an email on an account. How do you do that?
      • Can I change which email my customer receives their notifications?
      • Can I remove an email address from a customer's account?
      • Can you change the name of a customer?
      • My customer has two accounts. What should I do?
      • How Do I Change the Email That I Use to Log in to Perkville?
      • My customer does not want to receive emails every time. What should I do?
      • How do I reset my password?
      • Answering "How can I deactivate my Perkville points account?"
    • Points
      • My customer's points are being expired. Why?
      • My customer is missing points. What should I do?
      • How do we add points to a customer or member account?
      • Can you reactivate points that expired?
    • Redemptions
      • A customer accidentally redeemed a reward. What should I do?
    • Referrals
      • Can you reward a customer for referring their friend?
      • Do referral offers expire and if so, is the referral notified?
      • I don't want customers to automatically get referral points. I want to manually complete referrals.
      • Referral submission error for front desk staff
      • How do I check if a referral has been submitted and its status?
Powered by GitBook
LogoLogo
On this page

Was this helpful?

  1. Overview
  2. Integrations
  3. Integrating Perkville

Integrating Your Mobile App with Perkville

PreviousAutomating your program using Perkville's APINextPage to initiate the PKCE flow.

Last updated 5 months ago

Was this helpful?

There are three primary options for developers to integrate their mobile app with Perkville. Please note that Perkville is integrated with some mobile applications out of the box such as with and .

1. Simple Link or Button

Implement a simple link or button in your app that connects to Perkville’s mobile-optimized web experience. When the customer clicks on the link or button, their browser (e.g., Google Chrome or Safari) will open, allowing them to log in to Perkville and view their account. Perkville will cookie their browser, ensuring they won’t have to log in again. This method works well with partners like , as the customer will remain logged into Perkville in their browser, allowing the partner's single sign-on functionality with Perkville to continue working seamlessly.

2. PKCE OAuth

Utilize the flow for authentication. In this method, the customer clicks a link in the mobile app to connect Perkville to the app. The customer is taken to a browser to complete the Oauth flow including logging into Perkville if they are not already signed in. The resulting token is then securely stored in the app, which can be used to call on behalf of the customer. This approach also integrates well with partners like , for the same reason mentioned above.

3. Use Admin Credentials

Store your business's Perkville admin credentials on your server and use these credentials to call to fetch loyalty data for customers. This method allows the business to replicate the Perkville experience such as displaying earning rules, rewards as well as take actions on behalf of the customer such as joining the loyalty program and redeeming rewards but without the user having to register or login to Perkville.

Hybrid Approach

A hybrid approach is also possible. For example, you can use the PKCE OAuth flow or admin credentials to initially display the member’s point balance, while providing a link for accessing other functionalities. Over time, the loyalty program screens can be replicated within the mobile app for a more integrated experience.

Preferred Method

Most developers choose the PKCE OAuth flow because it enables them to provide customers with a native experience in their mobile app without the need for server-side development.

In the following pages, we will provide detailed instructions on how to implement the PKCE OAuth method and the necessary Perkville API calls to replicate each page.

Mariana Tek's mobile app
ABC Fitness Ignite Engagement App
Solution One
PKCE OAuth
Perkville’s API
Solution One
Perkville’s API