# Getting started

## 🚀 Getting Started with Fyre POS Partner

Welcome to the **Fyre POS Partner documentation**!

This guide is designed for **POS software providers** who want to collaborate with Fyre to:

* 🔒 Share transactional data securely
* 📊 Enable anonymized insights and activation for clients
* 🌍 Power analytics and market insights across multiple venues and markets

Fyre works closely with POS partners to process data in a **structured and privacy-safe way**, ensuring both reliability and compliance. This documentation will walk you through:

1. What you need to get started
2. Required information upfront
3. How the integration process works from **preparation → production**

***

### 👥 Who this documentation is for

This guide is relevant to multiple roles within a POS organization:

* 🛠️ **Engineering teams** – building and maintaining integrations
* 📈 **Product & Data teams** – ensuring data quality and structure
* 🤝 **Decision makers** – overseeing partnerships and data sharing

> Not every section needs to be read start-to-finish. Jump to what’s relevant for your role!

***

### ⚙️ How the integration process works

Integrating with Fyre follows a **clear and predictable sequence**:

1. **Preparation phase**
   * Share basic outlet info & a sample of transactional data
   * Align on structure, data quality, and scope
2. **Technical integration**
   * Finalize delivery model
   * Set up API / data flows
3. **Scaling**
   * Enable historical data delivery
   * Daily data flows and additional API capabilities

> Each step builds on the previous one, minimizing rework and surprises.

***

### 🗂️ How this documentation is organized

The guide is split into main sections:

* [**Preparing for Integration**](https://doc.fyre.app/partners-api/partners/preparing-for-integration) – what info to collect before starting
* [**Standardized Transactional Format**](https://doc.fyre.app/partners-api/partners/standardized-transactional-format) – canonical data structure across markets
* [**Data Delivery Models**](https://doc.fyre.app/partners-api/partners/data-delivery-models) – supported delivery options (API, files, reverse integration)
* [**Using the Fyre API** ](https://doc.fyre.app/partners-api/partners/using-the-fyre-api)– authentication, access, and usage tips

> You can read sections independently, but we recommend following the journey in order when onboarding a new integration.

***

### 🏁 Where to start

* **New to Fyre?** Start with [**Preparing for Integration**](https://doc.fyre.app/partners-api/partners/preparing-for-integration) to gather all required info.
* **Familiar with the process?** Jump straight to [**Standardized Transactional Format**](https://doc.fyre.app/partners-api/partners/standardized-transactional-format) or [**Data Delivery Models**](https://doc.fyre.app/partners-api/partners/data-delivery-models).


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.fyre.app/partners-api/partners/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.