如何将多个查询参数发送到api?

时间:2019-08-12 18:34:53

标签: api oauth magento2

我正在调用API以获取发货清单,但似乎无法分页显示结果。

仅使用一个查询参数即可成功进行API调用,但是当我使用两个查询参数进行调用时,会出现错误“签名无效。请验证并重试”。我在下面包括我的测试代码。

<?php
function sign($method, $url, $data, $consumerSecret, $tokenSecret)
{
    $url = urlEncodeAsZend($url);

    $data = urlEncodeAsZend(http_build_query($data, '', '&'));
    $data = implode('&', [$method, $url, $data]);

    $secret = implode('&', [$consumerSecret, $tokenSecret]);

    return base64_encode(hash_hmac('sha1', $data, $secret, true));
}

function urlEncodeAsZend($value)
{
    $encoded = rawurlencode($value);
    $encoded = str_replace('%7E', '~', $encoded);
    return $encoded;
}

// REPLACE WITH YOUR ACTUAL DATA OBTAINED WHILE CREATING NEW INTEGRATION
$consumerKey       = 'htj8ze6ntr0mz1s4hjxrqeicia8rxgt4';
$consumerSecret    = 'djjzdwfgbbr7ganlkv01qr6p3l7ptvfe';
$accessToken       = '60o0mfrvqnjvin7tjuqsv37arijrqe9e';
$accessTokenSecret = 'caq9wfdx99zaygwgbhw91i9imj89p4zb';

$method = 'GET';

/* test 1 PASS */
//$url = 'http://localhost/rest/V1/shipments/';
//$qs = ['searchCriteria'=>'all'];

/* test 2 PASS */
//$url = 'http://localhost/rest/V1/shipments/';
//$qs = ['searchCriteria[pageSize]'=>'10'];

/* test 3 FAIL "The signature is invalid. Verify and try again" */
$url = 'http://localhost/rest/V1/shipments/';
$qs = ['searchCriteria[pageSize]'=>'10', 'searchCriteria[currentPage]'=>'1'];

$data = [
    'oauth_consumer_key' => $consumerKey,
    'oauth_nonce' => md5(uniqid(rand(), true)),
    'oauth_signature_method' => 'HMAC-SHA1',
    'oauth_timestamp' => time(),
    'oauth_token' => $accessToken,
    'oauth_version' => '1.0',
];
$data = array_merge($data, $qs);

$data['oauth_signature'] = sign($method, $url, $data, $consumerSecret, $accessTokenSecret);

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => 1,
    CURLOPT_URL => $url .'?' .http_build_query($qs),
    CURLOPT_HTTPHEADER => [
        'Authorization: OAuth ' . http_build_query($data, '', ',')
    ]
]);

$result = curl_exec($curl);
curl_close($curl);
echo($result);

该代码包括三个测试。

如果我取消对测试1的注释并取消对测试2和3的注释,则代码可以正常工作,并且可以获得发货清单。

如果我取消对测试2的注释以及对测试1和3的注释,则代码可以正常工作,并且我会收到发货清单。

如果我按原样运行代码,则会收到消息“签名无效。请验证并重试。”

我正在运行Magento版本。 2.3.2

2 个答案:

答案 0 :(得分:1)

技巧是对参数进行排序。我有一些client code人感兴趣。

curl --insecure --location --request GET 'http://.../backend/orders' --header 'Content-Type: application/json' --header 'ORDER_ID: 1234'

答案 1 :(得分:0)

尽管这个问题很旧,但我想为以后的案例发布答案。

问题中的代码很好,并且对我有很大帮助。

需要按键对参数进行排序。另外,请考虑searchCriteria是多维数组。因此,必须按键对数组进行递归排序。