Welcome to Sparkfly's Platform API Documentation

Welcome to the official documentation for Sparkfly's Platform API.

The platform has several top level APIs, each designed to handle specific aspects of the platform's functionality. Below is an overview of the main APIs available:

• Authentication: Sparkfly's platform uses a central authentication service shared across all public APIs. Authentication begins with obtaining an auth token via the Authentication API, which is then used to authorize requests to other APIs.
• Offers: This collection of related APIs are the core of Sparkfly's offer platform.
  • Administrative Functions: Manage offers, campaigns, item sets, items and much more.
  • Member Management: Manage members, member profiles, digital wallets and other member-related functionality. Issue offers, retrieve member wallets, update member profiles, and more.
• Loyalty: Sparkfly's loyalty APIs are the programmatic interface to Sparkfly's loyalty platform, enabling the management of loyalty programs, tiers, points, and rewards.
• Fraud Detection: Manage fraud detection rules and retrieval of fraud detection results.
• Events: Real-time event and webhook management for integrating with Sparkfly's event-driven architecture.

In addition to these core APIs, Sparkfly integrates with several point-of-sale (POS) systems. To support custom POS integrations, or to allow integrating with the Sparkfly transaction processing and real-time discounting engine, Sparkfly provides the following APIs:

• POS API: This API allows integration with various point-of-sale systems, enabling the processing of transactions and application of offers in real-time.