Getting Started

Welcome to the Fyre POS Partner documentation.

This documentation is for POS software providers who want to work with Fyre to securely share transactional data and enable anonymized insights and activation use cases for their clients.

Fyre collaborates with POS partners across multiple markets to process transactional data in a structured and privacy-safe way. This data is used to power market insights, analytics, and activation features for brands, partners, and venues.

This documentation explains how to get started, what information is required upfront, and how the integration process is structured from preparation through production.

Who this documentation is for

This documentation is intended for several roles within a POS organization, including:

Engineering teams responsible for building and maintaining integrations Product and data teams involved in data availability and structure Decision makers involved in partnerships and data sharing

Not every section needs to be read end-to-end. The documentation is structured so each team can focus on the parts that are relevant to their role.

How the integration process works

Integrating with Fyre follows a clear and predictable sequence.

The process starts with a short preparation phase. During this phase, basic information about outlets and a sample of transactional data are shared. This allows both sides to align on structure, data quality, and scope before any production data is enabled.

Once preparation is completed, the delivery model is finalized and the technical integration is put in place. From there, the integration can scale to historical data delivery, ongoing daily data flows, and additional API-based capabilities over time.

Each step builds on the previous one and is designed to minimize rework and uncertainty later in the process.

How this documentation is organized

he documentation is organized into a few main sections, each covering a specific part of the journey:

Preparing for Integration Explains what information is required before technical work begins, including outlet details and sample transactional data.

Standardized Transactional Format Defines the canonical structure used to represent transactional data across partners and markets.

Data Delivery Models Describes the supported ways of delivering data to Fyre, including API-based delivery, file-based delivery, and reverse integration.

Using the Fyre API Covers how to work with the Fyre API once a delivery model is agreed, including authentication and access.

Each section can be read independently, but they are designed to be followed in order when onboarding a new integration.

Where to start

If you are new to Fyre integrations, start with Preparing for Integration to understand what information is required upfront.

If you are already familiar with the process and want to focus on implementation details, you can jump directly to Standardized Transactional Format or Data Delivery Models.