General API Information

The Sparkfly POS API uses standard secured HTTP requests with JSON payloads. Requests to the platform with content bodies should be JSON and have Content-Type: application/json.

The endpoint addresses (specifically, the host) listed in this document may change based on environment. Please verify with Sparkfly on the proper API host and authentication credentials for your account.

All API endpoints are authenticated using an authentication token, which can be obtained by first sending authentication credentials to the /auth endpoint.

Terminology

Throughout this document we will use terms which have significance in the Sparkfly universe.

Term	Definition
Credential	A unique string of text linked to one or more offers. May be a coupon code, phone number, or any other piece of identifying information.
Offer	A discount with one or more rules of eligibility. For example, an offer might be "$1.00 off any beverage". The discount is $1.00, the qualifying purchase is a beverage of some kind.
Check	A single check at a restaurant. Transactions with the POS API are performed at the granularity of the check. If a single table is split into multiple checks, each check is treated separately.
Transaction	Synonymous with check.
Offer Code	A type of credential, which refers to a Sparkfly offer.
POS Agent	Our term for software running on a Point-of-Sale system, either as a part of the POS platform itself or as a plug-in or as external software. The agnet is responsible for making requests to the POS API on behalf of the POS.