fillup/walmart-auth-signature-php

用于计算 Walmart API 认证签名的 PHP 库

1.0.3 2016-09-19 23:40 UTC

This package is auto-updated.

Last update: 2024-09-06 08:56:14 UTC


README

Walmart 使用签名计算算法进行 API 调用认证,这个算法相当复杂,因此这个库旨在使调用函数一样简单。

构建状态

Build Status Coverage Status

安装

安装此库最简单的方法是使用 Composer。只需将以下内容添加到您的 composer.json 文件中

"fillup/walmart-auth-signature-php": "dev-master"

或者运行 composer require fillup/walmart-auth-signature-php:dev-master。这假设您已安装 composer 并将其路径设置为 composer

版本控制

此库同时使用语义版本控制和 Git Flow 流程进行开发。使用 dev-master 应该是安全的,因为 master 分支被认为是 生产就绪 的。

使用方法

您可以使用对象形式的 Walmart\Auth\Signature 类,或者通过调用其静态方法。

对象接口

如果您需要多次进行 API 调用,您可以实例化一个签名对象,并简单地通过调用 getSignature 方法来获取新的签名。

<?php

use Walmart\Auth\Signature as AuthSignature;

$authSignature = new AuthSignature($consumerId, $privateKey, $requestUrl, $requestMethod);
$signatureString = $authSignature->getSignature();

// Make your call

// Get a new signature for a new call
$signatureString = $authSignature->getSignature(null,$newUrl);

静态方法接口

有时直接调用静态方法更简单或更优雅,请看以下内容

<?php

use Walmart\Auth\Signature as AuthSignature;

$signatureString = AuthSignature::calculateSignature($consumerId, $privateKey, $requestUrl, $requestMethod);

// Make your call

// Get a new signature for a new call
$signatureString = AuthSignature::calculateSignature($consumerId, $privateKey, $requestUrl, $requestMethod);

贡献

我感激问题报告和拉取请求,因此如果您看到改进的机会,请告知我们并提交拉取请求。

许可协议

MIT 许可协议 (MIT)

版权所有 (c) 2015 Phillip Shipley

特此授予任何获得此软件及其相关文档副本(“软件”)的人免费权限,可以不受限制地处理该软件,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本,以及允许向软件提供方提供软件的人这样做,前提是以下条件

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

该软件按“原样”提供,不提供任何形式的保证,无论是明示的还是隐含的,包括但不限于适销性、针对特定目的的适用性和非侵权性保证。在任何情况下,作者或版权所有者都不应对任何索赔、损害或其他责任承担责任,无论此类责任是基于合同、侵权或其他原因,以及此类责任是否源自、源于或与此软件或软件的使用或其他交易有关。