Difference between revisions of "Using the API"

From Spiffy Stores Knowledge Base

(Created page with "The Spiffy Stores API is a RESTful web service. === Authentication === It uses HTTP Basic Authentication to allow private applications to connect to a store using an API key...")
 
Line 3: Line 3:
 
=== Authentication ===
 
=== Authentication ===
  
It uses HTTP Basic Authentication to allow private applications to connect to a store using an API key generated by that store.
+
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.
 
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.

Revision as of 10:59, 18 November 2014

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.