Integrating Your Mobile App with Perkville

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 Mariana Tek's mobile app and ABC Fitness Ignite Engagement App.

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 Solution One, 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 PKCE OAuth 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 Perkville’s API on behalf of the customer. This approach also integrates well with partners like Solution One, 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 Perkville’s API 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.