> For the complete documentation index, see [llms.txt](https://help.openloyalty.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.openloyalty.io/technical-guide/integration/integration-examples.md).

# Integration Examples

Integrating Open Loyalty with your existing systems can be a powerful way to enhance customer engagement, streamline processes, and create a seamless loyalty experience. To help developers and technical teams, we’ve compiled a series of practical integration examples that demonstrate how to connect Open Loyalty with various platforms and tools.

These examples cover a wide range of use cases, including API-driven workflows, webhook configurations, and event-driven architectures. By exploring these scenarios, you’ll gain valuable insights into how Open Loyalty can be customized to fit your business needs and technical environment.

### API Integration Example

* **Scenario:** An e-commerce platform wants to integrate Open Loyalty to manage its customer loyalty program using a middleware layer for API orchestration.
* **Middleware Layer:** The e-commerce platform introduces a middleware layer that handles API orchestration, decoupling the e-commerce system from the Open Loyalty API.

{% stepper %}
{% step %}
When a customer makes a purchase, the e-commerce platform sends a request to the middleware, which then communicates with Open Loyalty's API to add points based on the transaction value.
{% endstep %}

{% step %}
The middleware retrieves customer loyalty data from Open Loyalty's API and processes\
it before passing it to the e-commerce platform to display rewards, tiers, and available points on the user's profile.
{% endstep %}

{% step %}
The middleware periodically sends\
API requests to update customer tiers or trigger special campaigns based on customer behavior, keeping the e-commerce platform informed of any updates.
{% endstep %}
{% endstepper %}

<figure><img src="https://123136216-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgIv2CyIIYf7vRfuhMKQ6%2Fuploads%2Fgit-blob-09cf752746df559633c868c0796cafea411039a3%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>


---

# 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://help.openloyalty.io/technical-guide/integration/integration-examples.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.