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

# Introduction

This guide was created to help you integrate with Open Loyalty API. If you have any questions, ideas, or feedback, feel free to get in touch via www\.openloyalty.io.

This resource is designed to help you effectively utilize the Open Loyalty platform. Dive in to optimize your customer loyalty strategies and leverage the full potential of our API-first, flexible platform.

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Getting Started Guide</strong></td><td>Step-by-step guide on your first integration with Open Loyalty</td><td></td><td><a href="/technical-guide/getting-started-guide.md">Getting Started Guide</a></td><td><a href="https://123136216-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgIv2CyIIYf7vRfuhMKQ6%2Fuploads%2Fgit-blob-3a46d059f0811196b1a2e53ab422a7b7c109f547%2F6464e65c528649dc3b04ce39_Loyalty%20program%20implementation%20checklist%20-%20small%20cover%201x-p-800.webp?alt=media">6464e65c528649dc3b04ce39_Loyalty program implementation checklist - small cover 1x-p-800.webp</a></td></tr><tr><td><strong>API Fundamentals</strong></td><td>See the tips and performance overview of our API</td><td></td><td><a href="/technical-guide/api-fundamentals/environments-capabilities.md">Environments Capabilities</a></td><td><a href="https://123136216-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgIv2CyIIYf7vRfuhMKQ6%2Fuploads%2Fgit-blob-5bc25cfe88d169332697d95a9022d81e11fed402%2F646ef25d9a947b62712dea64_Loyalty%20campaign%20templates%20-%20small%201x-p-800.webp?alt=media">646ef25d9a947b62712dea64_Loyalty campaign templates - small 1x-p-800.webp</a></td></tr><tr><td><strong>Authentication Flow</strong></td><td>Securing your application starts with a robust authentication flow. See the best approaches for authentication.</td><td></td><td><a href="/technical-guide/authentication/admin-token.md">Admin Token</a></td><td><a href="https://123136216-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgIv2CyIIYf7vRfuhMKQ6%2Fuploads%2Fgit-blob-2aea0b69b8cb6330ae02fb4a5f280c27aa6295ae%2F63bd9fbf3eaca85067539477_631f0e6aa7dddae04af272a6_blockchain20interview-small-p-800.webp?alt=media">63bd9fbf3eaca85067539477_631f0e6aa7dddae04af272a6_blockchain20interview-small-p-800.webp</a></td></tr><tr><td><strong>API Reference</strong></td><td>Have a look at the complete API Reference</td><td></td><td><a href="https://apidocs.openloyalty.io/">https://apidocs.openloyalty.io/</a></td><td><a href="https://123136216-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgIv2CyIIYf7vRfuhMKQ6%2Fuploads%2Fgit-blob-df57f680f82c946850f6eedd6c08dd56b528195c%2F63bd9fbd2dfc336b590107a8_6310936705bc51d2516d8c6d_recruitment-cover-big.webp?alt=media">63bd9fbd2dfc336b590107a8_6310936705bc51d2516d8c6d_recruitment-cover-big.webp</a></td></tr></tbody></table>


---

# 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/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.