> 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/implementation-guide/getting-started.md).

# Implementation Guide

How to plan, integrate and launch a loyalty programme on Open Loyalty — for solution architects, integration developers and project teams.

This guide covers what happens between signing up for Open Loyalty and a programme running in production: how the pieces fit together, which decisions to make early, how each module is integrated, and what to check before go-live.

It doesn't repeat how to click through the Admin Panel or what every API field means. For that it links to the [User Guide](https://help.openloyalty.io/) and the [Developer Guide](https://help.openloyalty.io/technical-guide), and to the [API reference](https://apidocs.openloyalty.io/).

## Who it's for

| You are…                                              | Start with                                                                                                                                                                           |
| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| A **project lead** planning the rollout               | [Implementation phases](/implementation-guide/plan-and-foundations/implementation-phases.md)                                                                                         |
| A **solution architect** designing the integration    | [Integration architecture](/implementation-guide/plan-and-foundations/integration-architecture.md), [Member identity](/implementation-guide/plan-and-foundations/member-identity.md) |
| An **integration developer** building against the API | [Environments & access](/implementation-guide/plan-and-foundations/environments-and-access.md), then the module checklists                                                           |
| A **programme manager** configuring the Admin Panel   | The module checklists' *Admin Panel* sections                                                                                                                                        |

## How the guide is organised

1. **Plan & foundations** — decisions that every module depends on: phases and responsibilities, architecture, how members are identified, environments, and multi-brand programmes.
2. **Module checklists** — one page per capability (members, transactions, campaigns, rewards, …), each with who does what, the design decisions, the recommended flow, sequence diagrams, a go-live checklist and the endpoints involved.
3. **Data & go-live** — migrating existing members and balances, moving configuration from staging to production, testing, the go-live checklist, and running the programme afterwards.
4. **Reference** — API best practices and every webhook event, with what each is used for.

{% hint style="info" %}
New to the API? Start with the Developer Guide's [Getting Started Guide](https://help.openloyalty.io/technical-guide/getting-started-guide), then come back to the module checklists.
{% 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://help.openloyalty.io/implementation-guide/getting-started.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.