Difference between revisions of "Using the API"

From Spiffy Stores Knowledge Base

Line 9: Line 9:
 
=== Calling the API ===
 
=== Calling the API ===
  
The Spiffy Stores API only supports JSON-encoded data as requests and responses. You will need to set both the <code>Content-Type</code> and <code>Accept headers</code> to <code>application/json</code> to identify the request and response format.
+
The Spiffy Stores API only supports JSON-encoded data as requests and responses. You will need to set both the <code>Content-Type</code> and <code>Accept</code> headers to <code>application/json</code> to identify the request and response format.

Revision as of 11:00, 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.