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:
What you need to get started
Required information upfront
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:
Preparation phase
Share basic outlet info & a sample of transactional data
Align on structure, data quality, and scope
Technical integration
Finalize delivery model
Set up API / data flows
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 – what info to collect before starting
Standardized Transactional Format – canonical data structure across markets
Data Delivery Models – supported delivery options (API, files, reverse integration)
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 to gather all required info.
Familiar with the process? Jump straight to Standardized Transactional Format or Data Delivery Models.
Last updated