Creating Private API Keys - Revision history

Admin: /* Perform Authenticated Requests */

2018-05-21T22:06:35Z

Perform Authenticated Requests

Admin at 22:05, 21 May 2018

2018-05-21T22:05:31Z

Admin at 06:00, 18 November 2014

2014-11-18T06:00:24Z

Admin at 05:43, 17 November 2014

2014-11-17T05:43:09Z

Admin at 05:39, 17 November 2014

2014-11-17T05:39:56Z

Admin at 05:39, 17 November 2014

2014-11-17T05:39:18Z

Admin: Created page with "Private API keys allow you to grant access to your store's data for individual applications. As an example, you would need to generate a set of API keys if you were writing a..."

2014-11-17T05:36:06Z

Created page with "Private API keys allow you to grant access to your store's data for individual applications. As an example, you would need to generate a set of API keys if you were writing a..."

New page

Private API keys allow you to grant access to your store's data for individual applications.

As an example, you would need to generate a set of API keys if you were writing an automation script to manage your store's inventory. You may also need to generate another set of API keys if you want to grant access to a web-based accounting system that supports the Spiffy Stores API and allow it to access your Order and Customer data.

Private API keys can be generated from your Toolbox under "Accounts -> API Keys".

Simple generate a new API key for each new application that needs API access. You should generate a new key for each application, and you should not share the same key across multiple applications.

You can revoke API access for an application by deleting its API key.

Once an API key has been generated, click on the API key line to edit the key label and see the private details.

@@ Line 34: / Line 34: @@
 # Join the API key and password with a single colon (:)
-# Encode the resulting string in base64 representation
+# Encode the resulting string in Base64 representation
-# Prepend the base64-encoded string with Basic and a space
+# Prepend the Base64-encoded string with "Basic" followed by a space
 <pre>
 Authorization: Basic YTFjZTdmMzg1NzdhZGVkMDY4M2M4N2RjZThkMGRiZmE6N2Q1NzQ2MzA4ZjVmMDYzOTNlOTAwMGVjYjEwZWI0Mzg=
 </pre>
 == Further Reference ==

← Older revision		Revision as of 22:05, 21 May 2018
Line 18:		Line 18:

	Once an API key has been generated, click on the API key line to edit the key label and see the private details.		Once an API key has been generated, click on the API key line to edit the key label and see the private details.
		+
		+	= Perform Authenticated Requests =
		+
		+	Private applications authenticate with Spiffy Stores through basic HTTP authorization, where the API key of the application is the username, and the Password is the password. You can generate these credentials from the store's Toolbox as described above.
		+
		+	Some HTTP clients support basic authentication by prepending "username:password@" to the hostname in the URL.
		+
		+	For example:
		+
		+	<pre>
		+	GET https://a1ce7f38577aded0683c87dce8d0dbfa:7d5746308f5f06393e9000ecb10eb438@mystore.spiffystores.com/api/resource.json
		+	</pre>
		+
		+	If your HTTP client doesn't support basic authentication using this method, then you can provide the credentials in the Authorization header field instead.
		+
		+	# Join the API key and password with a single colon (:)
		+	# Encode the resulting string in base64 representation
		+	# Prepend the base64-encoded string with Basic and a space
		+
		+	<pre>
		+	Authorization: Basic YTFjZTdmMzg1NzdhZGVkMDY4M2M4N2RjZThkMGRiZmE6N2Q1NzQ2MzA4ZjVmMDYzOTNlOTAwMGVjYjEwZWI0Mzg=
		+	</pre>
		+

	== Further Reference ==		== Further Reference ==

← Older revision		Revision as of 06:00, 18 November 2014
Line 18:		Line 18:

	Once an API key has been generated, click on the API key line to edit the key label and see the private details.		Once an API key has been generated, click on the API key line to edit the key label and see the private details.
		+
		+	== Further Reference ==
		+
		+	* [[An Introduction to the Spiffy Stores API]]
		+	* [[Using the API]]
		+	* [[API Reference]]

@@ Line 2: / Line 2: @@
 <gallery widths="200px" heights="200px" class="right">
-Image:Api_keys1.png|Product variations
+Image:Api_keys1.png|Creating a private API Key
 </gallery>

← Older revision		Revision as of 05:39, 17 November 2014
Line 1:		Line 1:
	Private API keys allow you to grant access to your store's data for individual applications.		Private API keys allow you to grant access to your store's data for individual applications.
		+
		+	<gallery widths="200px" heights="200px" class="right">
		+	Image:Api_keys1.png\|Product variations
		+	</gallery>

	As an example, you would need to generate a set of API keys if you were writing an automation script to manage your store's inventory. You may also need to generate another set of API keys if you want to grant access to a web-based accounting system that supports the Spiffy Stores API and allow it to access your Order and Customer data.		As an example, you would need to generate a set of API keys if you were writing an automation script to manage your store's inventory. You may also need to generate another set of API keys if you want to grant access to a web-based accounting system that supports the Spiffy Stores API and allow it to access your Order and Customer data.

@@ Line 9: / Line 9: @@
 Private API keys can be generated from your Toolbox under "Accounts -> API Keys".
-Simple generate a new API key for each new application that needs API access. You should generate a new key for each application, and you should not share the same key across multiple applications.
+<gallery widths="200px" heights="200px" class="right">
 You can revoke API access for an application by deleting its API key.
 Once an API key has been generated, click on the API key line to edit the key label and see the private details.