如何将 oAuth 与 Guzzle 5（或者更好的是，与 Guzzle 6）一起使用

Question

我正在尝试使用 Guzzle 5 连接到 WooCommerce API（Guzzle 6 似乎没有 oAuth 选项 o.O）。 Woocommerce requires the oAuth authentication method 开始工作。

这是我正在使用的代码：

<?php

/**
 * Example of usage of Guzzle 5 to get information
 * from a WooCommerce Store.
 */

require('../vendor/autoload.php');

use GuzzleHttp\Client;
use GuzzleHttp\Subscriber\Oauth\Oauth1;
use GuzzleHttp\Exception\RequestException;

$consumer_key = 'my_consumer_key'; // Add your own Consumer Key here
$consumer_secret = 'my_consumer_secret'; // Add your own Consumer Secret here
$store_url = 'http://example.com'; // Add the home URL to the store you want to connect to here
$api_path = '/wc-api/v2/';
$api_end_point = [
    'root' => '',
    'orders' => 'orders'
    ];

$base_uri = $store_url . $api_path;

$client = new Client([
    'base_url' => $base_uri,
    'defaults' => ['auth' => 'oauth']
    ]);

$oauth = new Oauth1([
    'consumer_key'    => $consumer_key,
    'consumer_secret' => $consumer_secret,
    'request_method'  => 'query'
]);

$client->getEmitter()->attach($oauth);

try
{
    $res = $client->get($api_end_point['orders']);
}
catch (RequestException $e)
{
    $res = $e;

    if ($e->hasResponse())
    {
        $res = $e->getResponse();
    }
}

print_r($res);

echo $res->getStatusCode();
// "200"
echo $res->getHeader('content-type');
// 'application/json; charset=utf8'
echo $res->getBody();
// {"type":"User"...'

这个代码returns一个

woocommerce_api_authentication_error: Invalid Signature - provided signature does not match

使用纯 curl 函数（使用 this package in which I've put some functions I found here），它起作用了，我得到了我想要的所有订单和其他数据。

一些其他细节

为了使用 Guzzle 5 和 oAuth，我使用了那些作曲家包：

"require": {
    "guzzlehttp/guzzle": "~5.0"
},
"require-dev": {
    "guzzlehttp/oauth-subscriber": "~0.2",
},

在创建签名时似乎有一些不同之处：the library I've used until now works, but the one created by the oAuth plugin (using the method getSignature()) 为 Guzzle 创建的签名没有，我不太习惯使用 oAuth 来查找错误。有没有人可以帮我找出问题所在？

Answer 1

现在插件 OauthSubscriber 仅适用于 Guzzle 6。再次测试，我发现了错误：它在方法 signUsingHmacSha1() 中无论如何都会向字符串添加一个符号 (&) 进行签名，这会导致 WooCommerce 出错。

我已经 opened a issue on GitHub and sent a pull request 修复了这个错误。

使用 Guzzle 6 连接到 WooCommerce API V2 的正确方法（一旦修复了错误！注意版本您连接的 WooCommerce API：API v3 仍然不起作用！) 是这样的：

use GuzzleHttp\Client; use GuzzleHttp\HandlerStack; use GuzzleHttp\Handler\CurlHandler; use GuzzleHttp\Subscriber\Oauth\Oauth1; $options = array( // Add the home URL to the store you want to connect to here (without the end / ) 'remoteUrl' => 'http://example.com/', // Add your own Consumer Key here 'remoteConsumerKey' => 'ck_4rdyourConsumerKey8ik', // Add your own Secret Key here 'remoteSecretKey' => 'cs_738youconsumersecret94i', // Add the endpoint base path 'remoteApiPath' => 'wc-api/v2/', ); $remoteApiUrl = $options['remoteUrl'] . $options['remoteApiPath']; $endpoint = 'orders'; $handler = new CurlHandler(); $stack = HandlerStack::create($handler); $middleware = new Oauth1([ 'consumer_key' => $options['remoteConsumerKey'], 'consumer_secret' => $options['remoteSecretKey'], 'token_secret' => '', 'token' => '', 'request_method' => Oauth1::REQUEST_METHOD_QUERY, 'signature_method' => Oauth1::SIGNATURE_METHOD_HMAC ]); $stack->push($middleware); $client = new Client([ 'base_uri' => $remoteApiUrl, 'handler' => $stack ]); $res = $client->get($endpoint, ['auth' => 'oauth');

如前所述，此连接仅适用于 WooCommerce 的版本 2 API。

我正在调查以了解为什么 V3 不起作用。

Answer 2

更新@Aerendir 回答

在他的拉取请求中，@Aerendir 写道：

In my case, I did the editing as I were trying to connect to the WooCommerce API version 2 but that version of the API didn't implement correctly the OAuth Core 1.0a spec. In fact, they fixed this issue in the version 3 of the API. See Differences between V3 and older versions.

source: https://github.com/guzzle/oauth-subscriber/pull/42#issuecomment-185631670

所以，为了让他的答案正常工作，我们需要使用 wc-api/v3/ 而不是wc-api/v2/.

以下代码可使用 Guzzle 6、oauth 和 WooCommerce api v3:

use GuzzleHttp\Client,
    GuzzleHttp\HandlerStack,
    GuzzleHttp\Handler\CurlHandler,
    GuzzleHttp\Subscriber\Oauth\Oauth1;

$url = 'http://localhost/WooCommerce/';
$api = 'wc-api/v3/';
$endpoint = 'orders';
$consumer_key = 'ck_999ffa6b1be3f38058ed83e5786ac133e8c0bc60';
$consumer_secret = 'cs_8f6c96c56a7281203c2ff35d71e5c4f9b70e9704';

$handler = new CurlHandler();
$stack = HandlerStack::create($handler);

$middleware = new Oauth1([
    'consumer_key'    => $consumer_key,
    'consumer_secret' => $consumer_secret,
    'token_secret'    => '',
    'token'           => '',
    'request_method' => Oauth1::REQUEST_METHOD_QUERY,
    'signature_method' => Oauth1::SIGNATURE_METHOD_HMAC
]);
$stack->push($middleware);

$client = new Client([
    'base_uri' => $url . $api,
    'handler' => $stack
]);

$response = $client->get( $endpoint, [ 'auth' => 'oauth' ] );
echo $response->getStatusCode() . '<br>';
echo $response->getHeaderLine('content-type') . '<br>';
echo $response->getBody();

如何将 oAuth 与 Guzzle 5（或者更好的是，与 Guzzle 6）一起使用

How to use oAuth with Guzzle 5 (or, better, with Guzzle 6)

php

curl

oauth

guzzle