Using the API

The Spiffy Stores API is a RESTful web service.

Authentication

The API uses HTTP Basic Authentication to allow private applications to connect to a store using an API key generated by that store.

It also uses OAuth 2 protocol to authenticate 3rd-party applications which can connect to any store which grants the application permission to do so.

Calling the API

The Spiffy Stores API only supports JSON-encoded data as requests and responses. You will need to set both the Content-Type and Accept headers to application/json to identify the request and response format.

API Usage Limits

The Spiffy Stores API is subject to rate limiting in order to protect the server and all the web-facing stores from being flooded with service requests.

The exact parameters of the rate limiting are subject to change from time to time, but are set to allow a generous amount of requests to be processed in a reasonably short period.

If at any time you experience requests being rejected due the number of requests exceeding the server limits, then please contact us to discuss your needs.

Dates and Times

All dates and times generated by the API are in UTC.