Skip to content

Commit 2ae06bc

Browse files
claudiosanchesclaudiosanches
committed
Merge pull request #35 from woothemes/wp-api-v1
WP REST API V1
2 parents 34863d9 + 51646e0 commit 2ae06bc

31 files changed

+24041
-672
lines changed

‎source/images/logo.png

1008 Bytes
Loading

‎source/images/woocommerce-api-key-generated.png

71.5 KB
Loading

‎source/images/woocommerce-api-keys-settings.png

93.8 KB
Loading

‎source/images/woocommerce-creating-api-keys.png

43.2 KB
Loading

‎source/includes/wp-api-v1/_authentication.md

+336
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,336 @@
1+
# Authentication #
2+
3+
WooCommerce includes two ways to authenticate with the WP REST API. In addition, it is possible to use any [WP REST API authentication](http://v2.wp-api.org/guide/authentication/) plugin or method too.
4+
5+
## REST API keys ##
6+
7+
To be unable to authenticate to any endpoint of our REST API you must generate a REST API keys, currently you can generate new REST API keys by the WordPress admin interface or by an endpoint to auto generate.
8+
9+
### Generating API keys in the WordPress admin interface ###
10+
11+
To create or manage keys for a specific WordPress user, go to WooCommerce > Settings > API > Keys/Apps.
12+
13+
![WooCommerce REST API keys settings](images/woocommerce-api-keys-settings.png)
14+
15+
Click in the "Add Key" button and in the next screen select the User you would like to generate a key for in the User field and add a Description. Choose the level of access for this REST API key, which can be Read access, Write access or Read/Write access. Then select the Generate API Key button and WooCommerce will generate REST API keys for that user.
16+
17+
![Creating a new REST API key](images/woocommerce-creating-api-keys.png)
18+
19+
Now that keys have been generated, you should see two new keys, a QRCode, and a Revoke API Key button. These two keys are your Consumer Key and Consumer Secret.
20+
21+
![Generated REST API key](images/woocommerce-api-key-generated.png)
22+
23+
### Auto generating API keys using our Application Authentication Endpoint ###
24+
25+
This endpoint can be used by any APP to *allow users to generate API keys* for your APP. This makes integration with WooCommerce API easier because the user only needs to grant access to your APP via a URL. After being redirected back to your APP, the API keys will be sent back in a separate POST request.
26+
27+
The following image illustrates how this works:
28+
29+
![Authentication Endpoint flow](images/woocommerce-auth-endpoint-flow.png)
30+
31+
<aside class="warning">
32+
This endpoint works exclusively for users to generate API keys and facilitate integration between the WooCommerce REST API and an application. In no way is this endpoint intended to be used as login method for customers.
33+
</aside>
34+
35+
#### URL parameters ####
36+
37+
| Parameter | Type | Description |
38+
|----------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
39+
| `app_name` | string | Your APP name <i class="label label-info">mandatory</i> |
40+
| `scope` | string | Level of access. Available: `read`, `write` and `read_write` <i class="label label-info">mandatory</i> |
41+
| `user_id` | string | User ID in your APP. For your internal reference, used when the user is redirected back to your APP. NOT THE USER ID IN WOOCOMMERCE <i class="label label-info">mandatory</i> |
42+
| `return_url` | string | URL the user will be redirected to after authentication <i class="label label-info">mandatory</i> |
43+
| `callback_url` | string | URL that will receive the generated API key. Note: this URL should be over **HTTPS** <i class="label label-info">mandatory</i> |
44+
45+
#### Creating an authentication endpoint URL ####
46+
47+
You must use the `/wc-auth/v1/authorize` endpoint and pass the above parameters as a query string.
48+
49+
> Example of how to build an authentication URL:
50+
51+
```shell
52+
# Bash example
53+
STORE_URL='http://example.com'
54+
ENDPOINT='/wc-auth/v1/authorize'
55+
PARAMS="app_name=My App Name&scope=read_write&user_id=123&return_url=http://app.com/return-page&callback_url=https://app.com/callback-endpoint"
56+
QUERY_STRING="$(perl -MURI::Escape -e 'print uri_escape($ARGV[0]);' "$PARAMS")"
57+
QUERY_STRING=$(echo $QUERY_STRING | sed -e "s/%20/\+/g" -e "s/%3D/\=/g" -e "s/%26/\&/g")
58+
59+
echo "$STORE_URL$ENDPOINT?$QUERY_STRING"
60+
```
61+
62+
```javascript
63+
var querystring = require('querystring');
64+
65+
var store_url = 'http://example.com';
66+
var endpoint = '/wc-auth/v1/authorize';
67+
var params = {
68+
app_name: 'My App Name',
69+
scope: 'read_write',
70+
user_id: 123,
71+
return_url: 'http://app.com/return-page',
72+
callback_url: 'https://app.com/callback-endpoint'
73+
};
74+
var query_string = querystring.stringify(params).replace(/%20/g, '+');
75+
76+
console.log(store_url + endpoint + '?' + query_string);
77+
```
78+
79+
```php
80+
<?php
81+
$store_url = 'http://example.com';
82+
$endpoint = '/wc-auth/v1/authorize';
83+
$params = [
84+
'app_name' => 'My App Name',
85+
'scope' => 'write',
86+
'user_id' => 123,
87+
'return_url' => 'http://app.com',
88+
'callback_url' => 'https://app.com'
89+
];
90+
$query_string = http_build_query( $params );
91+
92+
echo $store_url . $endpoint . '?' . $query_string;
93+
?>
94+
```
95+
96+
```python
97+
from urllib.parse import urlencode
98+
99+
store_url = 'http://example.com'
100+
endpoint = '/wc-auth/v1/authorize'
101+
params = {
102+
"app_name": "My App Name",
103+
"scope": "read_write",
104+
"user_id": 123,
105+
"return_url": "http://app.com/return-page",
106+
"callback_url": "https://app.com/callback-endpoint"
107+
}
108+
query_string = urlencode(params)
109+
110+
print("%s%s?%s" % (store_url, endpoint, query_string))
111+
```
112+
113+
```ruby
114+
require "uri"
115+
116+
store_url = 'http://example.com'
117+
endpoint = '/wc-auth/v1/authorize'
118+
params = {
119+
app_name: "My App Name",
120+
scope: "read_write",
121+
user_id: 123,
122+
return_url: "http://app.com/return-page",
123+
callback_url: "https://app.com/callback-endpoint"
124+
}
125+
query_string = URI.encode_www_form(params)
126+
127+
puts "#{store_url}#{endpoint}?#{query_string}"
128+
```
129+
130+
> Example of JSON posted with the API Keys
131+
132+
```
133+
{
134+
"key_id": 1,
135+
"user_id": 123,
136+
"consumer_key": "ck_xxxxxxxxxxxxxxxx",
137+
"consumer_secret": "cs_xxxxxxxxxxxxxxxx",
138+
"key_permissions": "read_write"
139+
}
140+
```
141+
142+
Example of the screen that the user will see:
143+
144+
![Authentication Endpoint example](images/woocommerce-auth-endpoint-example.png)
145+
146+
#### Notes ####
147+
148+
- While redirecting the user using `return_url`, you are also sent `success` and `user_id` parameters as query strings.
149+
- `success` sends `0` if the user denied, or `1` if authenticated successfully.
150+
- Use `user_id` to identify the user when redirected back to the (`return_url`) and also remember to save the API Keys when your `callback_url` is posted to after auth.
151+
- The auth endpoint will send the API Keys in JSON format to the `callback_url`, so it's important to remember that some languages such as PHP will not display it inside the `$_POST` global variable, in PHP you can access it using `$HTTP_RAW_POST_DATA` (for old PHP versions) or `file_get_contents('php://input');`.
152+
153+
## Authentication over HTTPS ##
154+
155+
You may use [HTTP Basic Auth](http://en.wikipedia.org/wiki/Basic_access_authentication) by providing the REST API Consumer Key as the username and the REST API Consumer Secret as the password.
156+
157+
> HTTP Basic Auth example
158+
159+
```shell
160+
curl https://www.example.com/wp-json/wc/v1/orders \
161+
-u consumer_key:consumer_secret
162+
```
163+
164+
```javascript
165+
var WooCommerceAPI = require('woocommerce-api');
166+
167+
var WooCommerce = new WooCommerceAPI({
168+
url: 'https://example.com',
169+
consumerKey: 'consumer_key',
170+
consumerSecret: 'consumer_secret',
171+
wp_api: true,
172+
version: 'wc/v1'
173+
});
174+
```
175+
176+
```php
177+
<?php
178+
require __DIR__ . '/vendor/autoload.php';
179+
180+
use Automattic\WooCommerce\Client;
181+
182+
$woocommerce = new Client(
183+
'https://example.com',
184+
'consumer_key',
185+
'consumer_secret',
186+
[
187+
'wp_api' => true,
188+
'version' => 'wc/v1'
189+
]
190+
);
191+
?>
192+
```
193+
194+
```python
195+
from woocommerce import API
196+
197+
wcapi = API(
198+
url="https://example.com",
199+
consumer_key="consumer_key",
200+
consumer_secret="consumer_secret",
201+
wp_api=True,
202+
version="wc/v1"
203+
)
204+
```
205+
206+
```ruby
207+
require "woocommerce_api"
208+
209+
woocommerce = WooCommerce::API.new(
210+
"https://example.com",
211+
"consumer_key",
212+
"consumer_secret",
213+
{
214+
wp_json: true,
215+
version: "v3"
216+
}
217+
)
218+
```
219+
220+
Occasionally some servers may not parse the Authorization header correctly (if you see a "Consumer key is missing" error when authenticating over SSL, you have a server issue). In this case, you may provide the consumer key/secret as query string parameters instead.
221+
222+
> Example for servers that not properly parse the Authorization header:
223+
224+
```shell
225+
curl https://www.example.com/wp-json/wc/v1/orders?consumer_key=123&consumer_secret=abc
226+
```
227+
228+
```javascript
229+
var WooCommerceAPI = require('woocommerce-api');
230+
231+
var WooCommerce = new WooCommerceAPI({
232+
url: 'https://example.com',
233+
consumerKey: 'consumer_key',
234+
consumerSecret: 'consumer_secret',
235+
wp_api: true,
236+
version: 'wc/v1',
237+
queryStringAuth: true // When true and using under HTTPS force Basic Authentication as query string
238+
});
239+
```
240+
241+
```php
242+
<?php
243+
require __DIR__ . '/vendor/autoload.php';
244+
245+
use Automattic\WooCommerce\Client;
246+
247+
$woocommerce = new Client(
248+
'https://example.com',
249+
'consumer_key',
250+
'consumer_secret',
251+
[
252+
'wp_api' => true,
253+
'version' => 'wc/v1',
254+
'query_string_auth' => true // When true and using under HTTPS force Basic Authentication as query string
255+
]
256+
);
257+
?>
258+
```
259+
260+
## Authentication over HTTP ##
261+
262+
You must use [OAuth 1.0a "one-legged" authentication](http://tools.ietf.org/html/rfc5849) to ensure REST API credentials cannot be intercepted by an attacker. Typically you will use any standard OAuth 1.0a library in the language of your choice to handle the authentication, or generate the necessary parameters by following the following instructions.
263+
264+
### Creating a signature ###
265+
266+
#### Collect the request method and URL ####
267+
268+
First you need to determine the HTTP method you will be using for the request, and the URL of the request.
269+
270+
The **HTTP method** will be `GET` in our case.
271+
272+
The **Request URL** will be the endpoint you are posting to, e.g. `http://www.example.com/wp-json/wc/v1/orders`.
273+
274+
#### Collect parameters ####
275+
276+
Collect and normalize your query string parameters. This includes all `oauth_*` parameters except for the `oauth_signature` itself.
277+
278+
These values need to be encoded into a single string which will be used later on. The process to build the string is very specific:
279+
280+
1. [Percent encode](https://dev.twitter.com/oauth/overview/percent-encoding-parameters) every key and value that will be signed.
281+
2. Sort the list of parameters alphabetically by encoded key.
282+
3. For each key/value pair:
283+
- Append the encoded key to the output string.
284+
- Append the `=` character to the output string.
285+
- Append the encoded value to the output string.
286+
- If there are more key/value pairs remaining, append a `&` character to the output string.
287+
288+
When percent encoding in PHP for example, you would use `rawurlencode()`.
289+
290+
When sorting parameters in PHP for example, you would use `uksort( $params, 'strcmp' )`.
291+
292+
> Parameters example:
293+
294+
```
295+
oauth_consumer_key=abc123&oauth_signature_method=HMAC-SHA1
296+
```
297+
298+
#### Create the signature base string ####
299+
300+
The above values collected so far must be joined to make a single string, from which the signature will be generated. This is called the signature base string in the OAuth specification.
301+
302+
To encode the HTTP method, request URL, and parameter string into a single string:
303+
304+
1. Set the output string equal to the uppercase **HTTP Method**.
305+
2. Append the `&` character to the output string.
306+
3. [Percent encode](https://dev.twitter.com/oauth/overview/percent-encoding-parameters) the URL and append it to the output string.
307+
4. Append the `&` character to the output string.
308+
5. [Percent encode](https://dev.twitter.com/oauth/overview/percent-encoding-parameters) the parameter string and append it to the output string.
309+
310+
> Example signature base string:
311+
312+
```
313+
GET&http%3A%2F%2Fwww.example.com%2Fwp-json%2Fwc%2Fv1%2Forders&oauth_consumer_key%3Dabc123%26oauth_signature_method%3DHMAC-SHA1
314+
```
315+
316+
#### Generate the signature ####
317+
318+
Generate the signature using the *signature base string* and your consumer secret key with the HMAC-SHA1 hashing algorithm.
319+
320+
In PHP you can use the [hash_hmac](http://php.net/manual/en/function.hash-hmac.php) function.
321+
322+
HMAC-SHA1 or HMAC-SHA256 are the only accepted hash algorithms.
323+
324+
If you are having trouble generating a correct signature, you'll want to review the string you are signing for encoding errors. The [authentication source](https://github.com/woothemes/woocommerce/blob/master/includes/api/class-wc-rest-authentication.php#L141) can also be helpful in understanding how to properly generate the signature.
325+
326+
### OAuth tips ###
327+
328+
* The OAuth parameters must be added as query string parameters and *not* included in the Authorization header. This is because there is no reliable cross-platform way to get the raw request headers in WordPress.
329+
* The required parameters are: `oauth_consumer_key`, `oauth_timestamp`, `oauth_nonce`, `oauth_signature`, and `oauth_signature_method`. `oauth_version` is not required and should be omitted.
330+
* The OAuth nonce can be any randomly generated 32 character (recommended) string that is unique to the consumer key. Read more suggestions on [generating nonces on the Twitter REST API forums](https://dev.twitter.com/discussions/12445).
331+
* The OAuth timestamp should be the unix timestamp at the time of the request. The REST API will deny any requests that include a timestamp outside of a 15 minute window to prevent replay attacks.
332+
* You must use the store URL provided by the index when forming the base string used for the signature, as this is what the server will use. (e.g. if the store URL includes a `www` sub-domain, you should use it for requests)
333+
* You may test your generated signature using LinkedIn's [OAuth test console](http://developer.linkedinlabs.com/oauth-test/) -- leave the member token/secret blank.
334+
* Twitter has great instructions on [generating signatures](https://dev.twitter.com/docs/auth/creating-signature) with OAuth 1.0a, but remember tokens are not used with this implementation.
335+
* Note that the request body is *not* signed as per the OAuth spec, see [Google's OAuth 1.0 extension](https://oauth.googlecode.com/svn/spec/ext/body_hash/1.0/oauth-bodyhash.html) for details on why.
336+
* If including parameters in your request, it saves a lot of trouble if you can order your query string items alphabetically.

0 commit comments

Comments
 (0)