search

API Reference

hashtag
API Reference

This section contains the technical reference for the Fyre Partner API.

The API provides a single, consistent interface for partners to exchange data with the Fyre platform. It is used to:

  • Deliver transactional data to Fyre

  • Access selected partner-facing features for connected outlets, such as challenges, activation, or insight capabilities

This page explains the overall scope of the API, how it is organized, and key concepts that apply across all endpoints. Detailed endpoint documentation is provided in the sections that follow.

hashtag
API Environment and Access

  • All API requests use the production Fyre API environment.

  • Base URL:

https://api.fyre.app

  • The API is versioned using a path-based scheme. All endpoints documented here use the /api/v1/ prefix.

  • Access is managed by Fyre and granted as part of the integration process. Usage is limited to the agreed scope.

  • Authentication details are covered in Authentication & API Access.

hashtag
Purpose of the API

The Fyre API serves as the primary technical interface between partner systems and the Fyre platform.

Through the API, partners can:

  • Deliver transactional data during the preparation phase and in production

  • Provide historical transactional data where applicable

  • Retrieve partner-facing information for their outlets

  • Participate in activation and challenge-based features as they are enabled

The same API integration is used throughout the lifecycle of the partnership. While available endpoints may expand, the integration surface and authentication model remain consistent.

hashtag
Outlet Identification

The fyre_id is the canonical identifier used to represent outlets within the Fyre platform.

hashtag
Key characteristics of fyre_id:

  • Generated and managed by Fyre

  • Uniquely identifies a single outlet within the Fyre platform

  • Contains no personally identifiable or business-identifying information

  • Stable over time and does not change for the lifetime of the outlet

The fyre_id is used across the API to reference outlets in a consistent and anonymized way. Most transactional and partner-facing endpoints use fyre_id as the primary outlet reference.

After the preparation phase, Fyre shares the assigned fyre_id values with the partner as part of the enriched outlet list. Partners are expected to store and reuse these identifiers when interacting with the API.

PreviousAuthentication & API AccessNextHeadless Authentication (SSO)

Last updated