> For the complete documentation index, see [llms.txt](https://docs.perkville.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.perkville.com/integrations/integrating-perkville.md).

# Integrating Perkville

Choose the integration method based on what you want customers or staff to accomplish.

## Build a customer-facing app experience

Use the [Perkville public API](https://www.perkville.com/developers/docs/v2/) to build supported loyalty and referral experiences in your mobile or web application. See [Integrating Your App with Perkville](https://docs.perkville.com/integrations/integrating-perkville/integrating-your-app-with-perkville.md) for guidance on authenticated customer views, points, earning, rewards, and referral interactions.

## Automate backend activity with business software

For attendance, purchases, memberships, and other qualifying events from a POS, scheduling, or membership system, Perkville generally uses [Middle](https://docs.perkville.com/integrations/middle-integration-capabilities.md) to connect with the source platform and apply the business's configured earning and eligibility rules. The [Integration Reference](https://docs.perkville.com/integrations/integration-reference.md) explains supported workflows and prerequisites by provider.

Existing legacy Perkville-managed backend integrations may remain in use by established customers. Their presence in documentation does not mean they are recommended for new deployments.

## If you operate a software platform

If you want your application to exchange data with Perkville, review [the integration API requirements](https://docs.perkville.com/integrations/integrating-perkville/api-requirements.md) and discuss available connectors, supported records, authentication, and operating responsibilities with Perkville.

{% hint style="info" %}
A backend sync, embedded member-app experience, and a simple link to a hosted rewards page are different capabilities. A referral prospect being sent to another system does not automatically complete a referral, and issuing a Perkville voucher does not necessarily fulfill the reward in the external system.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.perkville.com/integrations/integrating-perkville.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
